1 .. |(version)| replace:: 1.29
2 .. -*- reStructuredText -*-
8 -------------------------
9 A fast, light, GTK+ IDE
10 -------------------------
12 :Authors: Enrico Tröger,
22 This document is distributed under the terms of the GNU General Public
23 License as published by the Free Software Foundation; either version 2
24 of the License, or (at your option) any later version. A copy of this
25 license can be found in the file COPYING included with the source code
26 of this program, and also in the chapter `GNU General Public License`_.
40 Geany is a small and lightweight Integrated Development Environment. It
41 was developed to provide a small and fast IDE, which has only a few
42 dependencies on other packages. Another goal was to be as independent
43 as possible from a particular Desktop Environment like KDE or GNOME -
44 Geany only requires the GTK+ runtime libraries.
46 Some basic features of Geany:
50 * Autocompletion of symbols/words
51 * Construct completion/snippets
52 * Auto-closing of XML and HTML tags
54 * Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
58 * Build system to compile and execute your code
59 * Simple project management
67 You can obtain Geany from http://www.geany.org/ or perhaps also from
68 your distribution. For a list of available packages, please see
69 http://www.geany.org/Download/ThirdPartyPackages.
76 Geany is distributed under the terms of the GNU General Public License
77 as published by the Free Software Foundation; either version 2 of
78 the License, or (at your option) any later version. A copy of this
79 license can be found in the file COPYING included with the source
80 code of this program and in the chapter, `GNU General Public License`_.
82 The included Scintilla library (found in the subdirectory
83 ``scintilla/``) has its own license, which can be found in the chapter,
84 `License for Scintilla and SciTE`_.
91 This documentation is available in HTML and text formats.
92 The latest version can always be found at http://www.geany.org/.
94 If you want to contribute to it, see `Contributing to this document`_.
106 You will need the GTK (>= 2.24) libraries and their dependencies
107 (Pango, GLib and ATK). Your distro should provide packages for these,
108 usually installed by default. For Windows, you can download an installer
109 from the website which bundles these libraries.
115 There are many binary packages available. For an up-to-date but maybe
116 incomplete list see http://www.geany.org/Download/ThirdPartyPackages.
122 Compiling Geany is quite easy.
123 To do so, you need the GTK (>= 2.24) libraries and header files.
124 You also need the Pango, GLib and ATK libraries and header files.
125 All these files are available at http://www.gtk.org, but very often
126 your distro will provide development packages to save the trouble of
127 building these yourself.
129 Furthermore you need, of course, a C and C++ compiler. The GNU versions
130 of these tools are recommended.
132 Autotools based build system
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 To compile Geany yourself, you just need the Make tool, preferably GNU Make.
137 Then run the following commands::
152 The configure script supports several common options, for a detailed
158 You may also want to read the INSTALL file for advanced installation
161 * See also `Compile-time options`_.
163 Dynamic linking loader support and VTE
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165 In the case that your system lacks dynamic linking loader support, you
166 probably want to pass the option ``--disable-vte`` to the ``configure``
167 script. This prevents compiling Geany with dynamic linking loader
168 support for automatically loading ``libvte.so.4`` if available.
172 If there are any errors during compilation, check your build
173 environment and try to find the error, otherwise contact the mailing
174 list or one the authors. Sometimes you might need to ask for specific
175 help from your distribution.
180 If you want to find Geany's system files after installation you may
181 want to know the installation prefix.
183 Pass the ``--print-prefix`` option to Geany to check this - see
184 `Command line options`_. The first path is the prefix.
186 On Unix-like systems this is commonly ``/usr`` if you installed from
187 a binary package, or ``/usr/local`` if you build from source.
190 Editing system files is not necessary as you should use the
191 per-user configuration files instead, which don't need root
192 permissions. See `Configuration files`_.
202 You can start Geany in the following ways:
204 * From the Desktop Environment menu:
206 Choose in your application menu of your used Desktop Environment:
207 Development --> Geany.
209 At Windows-systems you will find Geany after installation inside
210 the application menu within its special folder.
212 * From the command line:
214 To start Geany from a command line, type the following and press
222 The Geany window is shown in the following figure:
224 .. image:: ./images/main_window.png
226 The workspace has the following parts:
229 * An optional toolbar.
230 * An optional sidebar that can show the following tabs:
232 * Documents - A document list, and
233 * Symbols - A list of symbols in your code.
235 * The main editor window.
236 * An optional message window which can show the following tabs:
238 * Status - A list of status messages.
239 * Compiler - The output of compiling or building programs.
240 * Messages - Results of 'Find Usage', 'Find in Files' and other actions
241 * Scribble - A text scratchpad for any use.
242 * Terminal - An optional terminal window.
246 Most of these can be configured in the `Interface preferences`_, the
247 `View menu`_, or the popup menu for the relevant area.
249 Additional tabs may be added to the sidebar and message window by plugins.
251 The position of the tabs can be selected in the interface preferences.
253 The sizes of the sidebar and message window can be adjusted by
254 dragging the dividers.
259 ============ ======================= =================================================
260 Short option Long option Function
261 ============ ======================= =================================================
262 *none* +number Set initial line number for the first opened file
263 (same as --line, do not put a space between the + sign
264 and the number). E.g. "geany +7 foo.bar" will open the
265 file foo.bar and place the cursor in line 7.
267 *none* --column Set initial column number for the first opened file.
269 -c dir_name --config=directory_name Use an alternate configuration directory. The default
270 configuration directory is ``~/.config/geany/`` and that
271 is where ``geany.conf`` and other configuration files
274 *none* --ft-names Print a list of Geany's internal filetype names (useful
275 for snippets configuration).
277 -g --generate-tags Generate a global tags file (see
278 `Generating a global tags file`_).
280 -P --no-preprocessing Don't preprocess C/C++ files when generating tags file.
282 -i --new-instance Do not open files in a running instance, force opening
283 a new instance. Only available if Geany was compiled
284 with support for Sockets.
286 -l --line Set initial line number for the first opened file.
288 *none* --list-documents Return a list of open documents in a running Geany
290 This can be used to read the currently opened documents in
291 Geany from an external script or tool. The returned list
292 is separated by newlines (LF) and consists of the full,
293 UTF-8 encoded filenames of the documents.
294 Only available if Geany was compiled with support for
297 -m --no-msgwin Do not show the message window. Use this option if you
298 do not need compiler messages or VTE support.
300 -n --no-ctags Do not load symbol completion and call tip data. Use this
301 option if you do not want to use them.
303 -p --no-plugins Do not load plugins or plugin support.
305 *none* --print-prefix Print installation prefix, the data directory, the lib
306 directory and the locale directory (in that order) to
307 stdout, one line each. This is mainly intended for plugin
308 authors to detect installation paths.
310 -r --read-only Open all files given on the command line in read-only mode.
311 This only applies to files opened explicitly from the command
312 line, so files from previous sessions or project files are
315 -s --no-session Do not load the previous session's files.
317 -t --no-terminal Do not load terminal support. Use this option if you do
318 not want to load the virtual terminal emulator widget
319 at startup. If you do not have ``libvte.so.4`` installed,
320 then terminal-support is automatically disabled. Only
321 available if Geany was compiled with support for VTE.
323 *none* --socket-file Use this socket filename for communication with a
324 running Geany instance. This can be used with the following
325 command to execute Geany on the current workspace::
327 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
329 *none* --vte-lib Specify explicitly the path including filename or only
330 the filename to the VTE library, e.g.
331 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
332 only needed when the auto-detection does not work. Only
333 available if Geany was compiled with support for VTE.
335 -v --verbose Be verbose (print useful status messages).
337 -V --version Show version information and exit.
339 -? --help Show help information and exit.
341 *none* [files ...] Open all given files at startup. This option causes
342 Geany to ignore loading stored files from the last
343 session (if enabled).
344 Geany also recognizes line and column information when
345 appended to the filename with colons, e.g.
346 "geany foo.bar:10:5" will open the file foo.bar and
347 place the cursor in line 10 at column 5.
349 Projects can also be opened but a project file (\*.geany)
350 must be the first non-option argument. All additionally
351 given files are ignored.
352 ============ ======================= =================================================
354 You can also pass line number and column number information, e.g.::
356 geany some_file.foo:55:4
358 Geany supports all generic GTK options, a list is available on the
370 At startup, Geany loads all files from the last time Geany was
371 launched. You can disable this feature in the preferences dialog
372 (see `General Startup preferences`_).
374 You can start several instances of Geany, but only the first will
375 load files from the last session. In the subsequent instances, you
376 can find these files in the file menu under the "Recent files" item.
377 By default this contains the last 10 recently opened files. You can
378 change the number of recently opened files in the preferences dialog.
380 To run a second instance of Geany, do not specify any filenames on
381 the command-line, or disable opening files in a running instance
382 using the appropriate command line option.
385 Opening files from the command-line in a running instance
386 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
388 Geany detects if there is an instance of itself already running and opens files
389 from the command-line in that instance. So, Geany can
390 be used to view and edit files by opening them from other programs
391 such as a file manager.
393 You can also pass line number and column number information, e.g.::
395 geany some_file.foo:55:4
397 This would open the file ``some_file.foo`` with the cursor on line 55,
400 If you do not like this for some reason, you can disable using the first
401 instance by using the appropriate command line option -- see the section
402 called `Command line options`_.
405 Virtual terminal emulator widget (VTE)
406 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
408 If you have installed ``libvte.so`` on your system, it is loaded
409 automatically by Geany, and you will have a terminal widget in the
410 notebook at the bottom.
412 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
413 will not be loaded. So there is no need to install the package containing
414 this file in order to run Geany. Additionally, you can disable the use
415 of the terminal widget by command line option, for more information
416 see the section called `Command line options`_.
418 You can use this terminal (from now on called VTE) much as you would
419 a terminal program like xterm. There is basic clipboard support. You
420 can paste the contents of the clipboard by pressing the right mouse
421 button to open the popup menu, and choosing Paste. To copy text from
422 the VTE, just select the desired text and then press the right mouse
423 button and choose Copy from the popup menu. On systems running the
424 X Window System you can paste the last selected text by pressing the
425 middle mouse button in the VTE (on 2-button mice, the middle button
426 can often be simulated by pressing both mouse buttons together).
428 In the preferences dialog you can specify a shell which should be
429 started in the VTE. To make the specified shell a login shell just
430 use the appropriate command line options for the shell. These options
431 should be found in the manual page of the shell. For zsh and bash
432 you can use the argument ``--login``.
435 Geany tries to load ``libvte.so``. If this fails, it tries to load
436 some other filenames. If this fails too, you should check whether you
437 installed libvte correctly. Again note, Geany will run without this
440 It could be, that the library is called something else than
441 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
442 please set a link to the correct file (as root)::
444 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
446 Obviously, you have to adjust the paths and set X to the number of your
449 You can also specify the filename of the VTE library to use on the command
450 line (see the section called `Command line options`_) or at compile time
451 by specifying the command line option ``--with-vte-module-path`` to
455 Defining own widget styles using .gtkrc-2.0
456 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
458 You can define your widget style for many of Geany's GUI parts. To
459 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
460 directory on UNIX-like systems and in the etc subdirectory of your
461 Geany installation on Windows).
463 To have a defined style used by Geany you must assign it to
464 at least one of Geany's widgets. For example use the following line::
466 widget "Geany*" style "geanyStyle"
468 This would assign your style "geany_style" to all Geany
469 widgets. You can also assign styles only to specific widgets. At the
470 moment you can use the following widgets:
482 An example of a simple ``.gtkrc-2.0``::
488 widget "GeanyMainWindow" style "geanyStyle"
494 widget "GeanyPrefsDialog" style "geanyStyle"
500 Switching between documents
501 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
503 The documents list and the editor tabs are two different ways
504 to switch between documents using the mouse. When you hit the key
505 combination to move between tabs, the order is determined by the tab
506 order. It is not alphabetical as shown in the documents list
507 (regardless of whether or not editor tabs are visible).
509 See the `Notebook tab keybindings`_ section for useful
510 shortcuts including for Most-Recently-Used document switching.
514 The `Document->Clone` menu item copies the current document's text,
515 cursor position and properties into a new untitled document. If
516 there is a selection, only the selected text is copied. This can be
517 useful when making temporary copies of text or for creating
518 documents with similar or identical contents.
521 Character sets and Unicode Byte-Order-Mark (BOM)
522 ------------------------------------------------
528 Geany provides support for detecting and converting character sets. So
529 you can open and save files in different character sets, and even
530 convert a file from one character set to another. To do this,
531 Geany uses the character conversion capabilities of the GLib library.
533 Only text files are supported, i.e. opening files which contain
534 NULL-bytes may fail. Geany will try to open the file anyway but it is
535 likely that the file will be truncated because it can only be read up
536 to the first occurrence of a NULL-byte. All characters after this
537 position are lost and are not written when you save the file.
539 Geany tries to detect the encoding of a file while opening it, but
540 auto-detecting the encoding of a file is not easy and sometimes an
541 encoding might not be detected correctly. In this case you have to
542 set the encoding of the file manually in order to display it
543 correctly. You can this in the file open dialog by selecting an
544 encoding in the drop down box or by reloading the file with the
545 file menu item "Reload as". The auto-detection works well for most
546 encodings but there are also some encodings where it is known that
547 auto-detection has problems.
549 There are different ways to set different encodings in Geany:
551 * Using the file open dialog
553 This opens the file with the encoding specified in the encoding drop
554 down box. If the encoding is set to "Detect from file" auto-detection
555 will be used. If the encoding is set to "Without encoding (None)" the
556 file will be opened without any character conversion and Geany will
557 not try to auto-detect the encoding (see below for more information).
559 * Using the "Reload as" menu item
561 This item reloads the current file with the specified encoding. It can
562 help if you opened a file and found out that the wrong encoding was used.
564 * Using the "Set encoding" menu item
566 Contrary to the above two options, this will not change or reload
567 the current file unless you save it. It is useful when you want to
568 change the encoding of the file.
570 * Specifying the encoding in the file itself
572 As mentioned above, auto-detecting the encoding of a file may fail on
573 some encodings. If you know that Geany doesn't open a certain file,
574 you can add the specification line, described in the next section,
575 to the beginning of the file to force Geany to use a specific
576 encoding when opening the file.
579 In-file encoding specification
580 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
582 Geany detects meta tags of HTML files which contain charset information
585 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
587 and the specified charset is used when opening the file. This is useful if the
588 encoding of the file cannot be detected properly.
589 For non-HTML files you can also define a line like::
591 /* geany_encoding=ISO-8859-15 */
595 # geany_encoding=ISO-8859-15 #
597 to force an encoding to be used. The #, /\* and \*/ are examples
598 of filetype-specific comment characters. It doesn't matter which
599 characters are around the string " geany_encoding=ISO-8859-15 " as long
600 as there is at least one whitespace character before and after this
601 string. Whitespace characters are in this case a space or tab character.
602 An example to use this could be you have a file with ISO-8859-15
603 encoding but Geany constantly detects the file encoding as ISO-8859-1.
604 Then you simply add such a line to the file and Geany will open it
605 correctly the next time.
607 Since Geany 0.15 you can also use lines which match the
608 regular expression used to find the encoding string:
609 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
612 These specifications must be in the first 512 bytes of the file.
613 Anything after the first 512 bytes will not be recognized.
617 # encoding = ISO-8859-15
621 # coding: ISO-8859-15
623 Special encoding "None"
624 ^^^^^^^^^^^^^^^^^^^^^^^
626 There is a special encoding "None" which uses no
627 encoding. It is useful when you know that Geany cannot auto-detect
628 the encoding of a file and it is not displayed correctly. Especially
629 when the file contains NULL-bytes this can be useful to skip auto
630 detection and open the file properly at least until the occurrence
631 of the first NULL-byte. Using this encoding opens the file as it is
632 without any character conversion.
635 Unicode Byte-Order-Mark (BOM)
636 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
638 Furthermore, Geany detects a Unicode Byte Order Mark (see
639 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
640 this feature is only available if the opened file is in a Unicode
641 encoding. The Byte Order Mark helps to detect the encoding of a file,
642 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
643 using a Byte Order Mark could cause some problems for programs not
644 expecting it, e.g. the compiler gcc stops
645 with stray errors, PHP does not parse a script containing a BOM and
646 script files starting with a she-bang maybe cannot be started. In the
647 status bar you can easily see whether the file starts with a BOM or
650 If you want to set a BOM for a file or if you want to remove it
651 from a file, just use the document menu and toggle the checkbox.
654 If you are unsure what a BOM is or if you do not understand where
655 to use it, then it is probably not important for you and you can
667 Geany provides basic code folding support. Folding means the ability to
668 show and hide parts of the text in the current file. You can hide
669 unimportant code sections and concentrate on the parts you are working on
670 and later you can show hidden sections again. In the editor window there is
671 a small grey margin on the left side with [+] and [-] symbols which
672 show hidden parts and hide parts of the file respectively. By
673 clicking on these icons you can simply show and hide sections which are
674 marked by vertical lines within this margin. For many filetypes nested
675 folding is supported, so there may be several fold points within other
679 You can customize the folding icon and line styles - see the
680 filetypes.common `Folding Settings`_.
682 If you don't like it or don't need it at all, you can simply disable
683 folding support completely in the preferences dialog.
685 The folding behaviour can be changed with the "Fold/Unfold all children of
686 a fold point" option in the preference dialog. If activated, Geany will
687 unfold all nested fold points below the current one if they are already
688 folded (when clicking on a [+] symbol).
689 When clicking on a [-] symbol, Geany will fold all nested fold points
690 below the current one if they are unfolded.
692 This option can be inverted by pressing the Shift
693 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
694 children of a fold point" option is enabled, pressing Shift will disable
695 it for this click and vice versa.
698 Column mode editing (rectangular selections)
699 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
701 There is basic support for column mode editing. To use it, create a
702 rectangular selection by holding down the Control and Shift keys
703 (or Alt and Shift on Windows) while selecting some text.
704 Once a rectangular selection exists you can start editing the text within
705 this selection and the modifications will be done for every line in the
708 It is also possible to create a zero-column selection - this is
709 useful to insert text on multiple lines.
711 Drag and drop of text
712 ^^^^^^^^^^^^^^^^^^^^^
714 If you drag selected text in the editor widget of Geany the text is
715 moved to the position where the mouse pointer is when releasing the
716 mouse button. Holding Control when releasing the mouse button will
717 copy the text instead. This behaviour was changed in Geany 0.11 -
718 before the selected text was copied to the new position.
724 Geany allows each document to indent either with a tab character,
725 multiple spaces or a combination of both.
727 The *Tabs* setting indents with one tab character per indent level, and
728 displays tabs as the indent width.
730 The *Spaces* setting indents with the number of spaces set in the indent
731 width for each level.
733 The *Tabs and Spaces* setting indents with spaces as above, then converts
734 as many spaces as it can to tab characters at the rate of one tab for
735 each multiple of the `Various preference` setting
736 *indent_hard_tab_width* (default 8) and displays tabs as the
737 *indent_hard_tab_width* value.
739 The default indent settings are set in `Editor Indentation
740 preferences`_ (see the link for more information).
742 The default settings can be overridden per-document using the
743 Document menu. They can also be overridden by projects - see
744 `Project management`_.
746 The indent mode for the current document is shown on the status bar
750 Indent with Tab characters.
754 Indent with tabs and spaces, depending on how much indentation is
757 Applying new indentation settings
758 `````````````````````````````````
759 After changing the default settings you may wish to apply the new
760 settings to every document in the current session. To do this use the
761 *Project->Apply Default Indentation* menu item.
763 Detecting indent type
764 `````````````````````
765 The *Detect from file* indentation preference can be used to
766 scan each file as it's opened and set the indent type based on
767 how many lines start with a tab vs. 2 or more spaces.
773 When enabled, auto-indentation happens when pressing *Enter* in the
774 Editor. It adds a certain amount of indentation to the new line so the
775 user doesn't always have to indent each line manually.
777 Geany has four types of auto-indentation:
780 Disables auto-indentation completely.
782 Adds the same amount of whitespace on a new line as on the previous line.
783 For the *Tabs* and the *Spaces* indent types the indentation will use the
784 same combination of characters as the previous line. The
785 *Tabs and Spaces* indentation type converts as explained above.
787 Does the same as *Basic* but also indents a new line after an opening
788 brace '{', and de-indents when typing a closing brace '}'. For Python,
789 a new line will be indented after typing ':' at the end of the
792 Similar to *Current chars* but the closing brace will be aligned to
793 match the indentation of the line with the opening brace. This
794 requires the filetype to be one where Geany knows that the Scintilla
795 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
798 There is also XML-tag auto-indentation. This is enabled when the
799 mode is more than just Basic, and is also controlled by a filetype
800 setting - see `xml_indent_tags`_.
806 Geany provides a handy bookmarking feature that lets you mark one
807 or more lines in a document, and return the cursor to them using a
810 To place a mark on a line, either left-mouse-click in the left margin
811 of the editor window, or else use Ctrl-m. This will
812 produce a small green plus symbol in the margin. You can have as many
813 marks in a document as you like. Click again (or use Ctrl-m again)
814 to remove the bookmark. To remove all the marks in a given document,
815 use "Remove Markers" in the Document menu.
817 To navigate down your document, jumping from one mark to the next,
818 use Ctrl-. (control period). To go in the opposite direction on
819 the page, use Ctrl-, (control comma). Using the bookmarking feature
820 together with the commands to switch from one editor tab to another
821 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
822 navigate around multiple files.
825 Code navigation history
826 ^^^^^^^^^^^^^^^^^^^^^^^
828 To ease navigation in source files and especially between
829 different files, Geany lets you jump between different navigation
830 points. Currently, this works for the following:
832 * `Go to symbol declaration`_
833 * `Go to symbol definition`_
838 When using one of these actions, Geany remembers your current position
839 and jumps to the new one. If you decide to go back to your previous
840 position in the file, just use "Navigate back a location". To
841 get back to the new position again, just use "Navigate forward a
842 location". This makes it easier to navigate in e.g. foreign code
843 and between different files.
846 Sending text through custom commands
847 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
849 You can define several custom commands in Geany and send the current
850 selection to one of these commands using the *Edit->Format->Send
851 Selection to* menu or keybindings. The output of the command will be
852 used to replace the current selection. This makes it possible to use
853 text formatting tools with Geany in a general way.
855 The selected text will be sent to the standard input of the executed
856 command, so the command should be able to read from it and it should
857 print all results to its standard output which will be read by
858 Geany. To help finding errors in executing the command, the output
859 of the program's standard error will be printed on Geany's standard
862 If there is no selection, the whole current line is used instead.
864 To add a custom command, use the *Send Selection to->Set Custom
865 Commands* menu item. Click on *Add* to get a new item and type the
866 command. You can also specify some command line options. Empty
867 commands are not saved.
869 Normal shell quoting is supported, so you can do things like:
871 * ``sed 's/\./(dot)/g'``
873 The above example would normally be done with the `Replace all`_
874 function, but it can be handy to have common commands already set up.
876 Note that the command is not run in a shell, so if you want to use
877 shell features like pipes and command chains, you need to explicitly
878 launch the shell and pass it your command:
880 * ``sh -c 'sort | uniq'``
886 You can execute the context action command on the current word at the
887 cursor position or the available selection. This word or selection
888 can be used as an argument to the command.
889 The context action is invoked by a menu entry in the popup menu of the
890 editor and also a keyboard shortcut (see the section called
893 The command can be specified in the preferences dialog and also for
894 each filetype (see "context_action_cmd" in the section called
895 `Filetype configuration`_). When the context action is invoked, the filetype
896 specific command is used if available, otherwise the command
897 specified in the preferences dialog is executed.
899 The current word or selection can be referred with the wildcard "%s"
900 in the command, it will be replaced by the current word or
901 selection before the command is executed.
903 For example a context action can be used to open API documentation
904 in a browser window, the command to open the PHP API documentation
907 firefox "http://www.php.net/%s"
909 when executing the command, the %s is substituted by the word near
910 the cursor position or by the current selection. If the cursor is at
911 the word "echo", a browser window will open(assumed your browser is
912 called firefox) and it will open the address: http://www.php.net/echo.
918 Geany can offer a list of possible completions for symbols defined in the
919 tags files and for all words in open documents.
921 The autocompletion list for symbols is presented when the first few
922 characters of the symbol are typed (configurable, see `Editor Completions
923 preferences`_, default 4) or when the *Complete word*
924 keybinding is pressed (configurable, see `Editor keybindings`_,
927 When the defined keybinding is typed and the *Autocomplete all words in
928 document* preference (in `Editor Completions preferences`_)
929 is selected then the autocompletion list will show all matching words
930 in the document, if there are no matching symbols.
932 If you don't want to use autocompletion it can be dismissed until
933 the next symbol by pressing Escape. The autocompletion list is updated
934 as more characters are typed so that it only shows completions that start
935 with the characters typed so far. If no symbols begin with the sequence,
936 the autocompletion window is closed.
938 The up and down arrows will move the selected item. The highlighted
939 item on the autocompletion list can be chosen from the list by pressing
940 Enter/Return. You can also double-click to select an item. The sequence
941 will be completed to match the chosen item, and if the *Drop rest of
942 word on completion* preference is set (in `Editor Completions
943 preferences`_) then any characters after the cursor that match
944 a symbol or word are deleted.
948 By default, pressing Tab will complete the selected item by word part;
949 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
954 * gtk_combo_box_<e><TAB>
955 * gtk_combo_box_entry_<s><ENTER>
956 * gtk_combo_box_entry_set_text_column
958 The key combination can be changed from Tab - See `Editor keybindings`_.
959 If you clear/change the key combination for word part completion, Tab
960 will complete the whole word instead, like Enter.
972 When you type ``foo.`` it will show an autocompletion list with 'i' and
975 It only works for languages that set parent scope names for e.g. struct
976 members. Currently this means C-like languages. The C parser only
977 parses global scopes, so this won't work for structs or objects declared
981 User-definable snippets
982 ^^^^^^^^^^^^^^^^^^^^^^^
984 Snippets are small strings or code constructs which can be replaced or
985 completed to a more complex string. So you can save a lot of time when
986 typing common strings and letting Geany do the work for you.
987 To know what to complete or replace Geany reads a configuration file
988 called ``snippets.conf`` at startup.
990 Maybe you need to often type your name, so define a snippet like this::
995 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
996 with "Enrico Tröger". The key to start autocompletion can be changed
997 in the preferences dialog, by default it is TAB. The corresponding keybinding
998 is called `Complete snippet`.
1002 You can override the default snippets using the user
1003 ``snippets.conf`` file. Use the *Tools->Configuration
1004 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1006 This adds the default settings to the user file if the file doesn't
1007 exist. Alternatively the file can be created manually, adding only
1008 the settings you want to change. All missing settings will be read
1009 from the system snippets file.
1013 The file ``snippets.conf`` contains sections defining snippets that
1014 are available for particular filetypes and in general.
1016 The two sections "Default" and "Special" apply to all filetypes.
1017 "Default" contains all snippets which are available for every
1018 filetype and "Special" contains snippets which can only be used in
1019 other snippets. So you can define often used parts of snippets and
1020 just use the special snippet as a placeholder (see the
1021 ``snippets.conf`` for details).
1023 You can define sections with the name of a filetype eg "C++". The
1024 snippets in that section are only available for use in files with that
1025 filetype. Snippets in filetype sections will hide snippets with the
1026 same name in the "Default" section when used in a file of that
1029 **Substitution sequences for snippets**
1031 To define snippets you can use several special character sequences which
1032 will be replaced when using the snippet:
1034 ================ =========================================================
1035 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1036 char(s): LF, CR/LF, or CR).
1038 \\t or %ws% Insert an indentation step, it will be replaced according
1039 to the current document's indent mode.
1041 \\s \\s to force whitespace at beginning or end of a value
1042 ('key= value' won't work, use 'key=\\svalue')
1044 %cursor% Place the cursor at this position after completion has
1045 been done. You can define multiple %cursor% wildcards
1046 and use the keybinding `Move cursor in snippet` to jump
1047 to the next defined cursor position in the completed
1050 %...% "..." means the name of a key in the "Special" section.
1051 If you have defined a key "brace_open" in the "Special"
1052 section you can use %brace_open% in any other snippet.
1053 ================ =========================================================
1055 Snippet names must not contain spaces otherwise they won't
1056 work correctly. But beside that you can define almost any
1057 string as a snippet and use it later in Geany. It is not limited
1058 to existing contructs of certain programming languages(like ``if``,
1059 ``for``, ``switch``). Define whatever you need.
1061 **Template wildcards**
1063 Since Geany 0.15 you can also use most of the available templates wildcards
1064 listed in `Template wildcards`_. All wildcards which are listed as
1065 `available in snippets` can be used. For instance to improve the above example::
1068 myname=My name is {developer}
1069 mysystem=My system: {command:uname -a}
1071 this will replace ``myname`` with "My name is " and the value of the template
1072 preference ``developer``.
1076 You can change the way Geany recognizes the word to complete,
1077 that is how the start and end of a word is recognised when the
1078 snippet completion is requested. The section "Special" may
1079 contain a key "wordchars" which lists all characters a string may contain
1080 to be recognized as a word for completion. Leave it commented to use
1081 default characters or define it to add or remove characters to fit your
1087 Normally you would type the snippet name and press Tab. However, you
1088 can define keybindings for snippets under the *Keybindings* group in
1093 block_cursor=<Ctrl>8
1096 Snippet keybindings may be overridden by Geany's configurable
1100 Inserting Unicode characters
1101 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1103 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1104 Ctrl-Shift, type some hex digits representing the code point for the character
1105 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1106 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1107 insertion is completed, but the typed character is also entered. In the case
1108 of Enter/Return, it is a newline, as you might expect.
1111 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1112 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1113 or restart Geany. Note that it works slightly differently from other GTK
1114 applications, in that you'll need to continue to hold down the Ctrl and Shift
1115 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1118 Search, replace and go to
1119 -------------------------
1121 This section describes search-related commands from the Search menu
1122 and the editor window's popup menu:
1129 * Go to symbol definition
1130 * Go to symbol declaration
1133 See also `Search`_ preferences.
1137 There are also two toolbar entries:
1142 There are keybindings to focus each of these - see `Focus
1143 keybindings`_. Pressing Escape will then focus the editor.
1147 The quickest way to find some text is to use the search bar entry in
1148 the toolbar. This performs a case-insensitive search in the current
1149 document whilst you type. Pressing Enter will search again, and pressing
1150 Shift-Enter will search backwards.
1155 The Find dialog is used for finding text in one or more open documents.
1157 .. image:: ./images/find_dialog.png
1163 The syntax for the *Use regular expressions* option is shown in
1164 `Regular expressions`_.
1167 *Use escape sequences* is implied for regular expressions.
1169 The *Use multi-line matching* option enables multi-line regular
1170 expressions instead of single-line ones. See `Regular expressions`_ for
1171 more details on the differences between the two modes.
1173 The *Use escape sequences* option will transform any escaped characters
1174 into their UTF-8 equivalent. For example, \\t will be transformed into
1175 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1176 (Unicode characters).
1182 To find all matches, click on the Find All expander. This will reveal
1189 Find All In Document will show a list of matching lines in the
1190 current document in the Messages tab of the Message Window. *Find All
1191 In Session* does the same for all open documents.
1193 Mark will highlight all matches in the current document with a
1194 colored box. These markers can be removed by selecting the
1195 Remove Markers command from the Document menu.
1198 Change font in search dialog text fields
1199 ````````````````````````````````````````
1201 All search related dialogs use a Monospace for the text input fields to
1202 increase the readability of input text. This is useful when you are
1203 typing input such as regular expressions with spaces, periods and commas which
1204 might it hard to read with a proportional font.
1206 If you want to change the font, you can do this easily
1207 by inserting the following style into your ``.gtkrc-2.0``
1208 (usually found in your home directory on UNIX-like systems and in the
1209 etc subdirectory of your Geany installation on Windows)::
1211 style "search_style"
1213 font_name="Monospace 8"
1215 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1217 Please note the addition of ":highest" in the last line which sets the priority
1218 of this style to the highest available. Otherwise, the style is ignored
1219 for the search dialogs.
1224 The *Find Next/Previous Selection* commands perform a search for the
1225 current selected text. If nothing is selected, by default the current
1226 word is used instead. This can be customized by the
1227 *find_selection_type* preference - see `Various preferences`_.
1229 ===== =============================================
1230 Value *find_selection_type* behaviour
1231 ===== =============================================
1232 0 Use the current word (default).
1233 1 Try the X selection first, then current word.
1234 2 Repeat last search.
1235 ===== =============================================
1241 *Find Usage* searches all open files. It is similar to the *Find All In
1242 Session* option in the Find dialog.
1244 If there is a selection, then it is used as the search text; otherwise
1245 the current word is used. The current word is either taken from the
1246 word nearest the edit cursor, or the word underneath the popup menu
1247 click position when the popup menu is used. The search results are
1248 shown in the Messages tab of the Message Window.
1251 You can also use Find Usage for symbol list items from the popup
1258 *Find in Files* is a more powerful version of *Find Usage* that searches
1259 all files in a certain directory using the Grep tool. The Grep tool
1260 must be correctly set in Preferences to the path of the system's Grep
1261 utility. GNU Grep is recommended (see note below).
1263 .. image:: ./images/find_in_files_dialog.png
1265 The *Search* field is initially set to the current word in the editor
1266 (depending on `Search`_ preferences).
1268 The *Files* setting allows to choose which files are included in the
1269 search, depending on the mode:
1272 Search in all files;
1274 Use the current project's patterns, see `Project properties`_;
1276 Use custom patterns.
1278 Both project and custom patterns use a glob-style syntax, each
1279 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1281 Note that an empty pattern list searches in all files rather
1284 The *Directory* field is initially set to the current document's directory,
1285 unless this field has already been edited and the current document has
1286 not changed. Otherwise, the current document's directory is prepended to
1287 the drop-down history. This can be disabled - see `Search`_ preferences.
1289 The *Encoding* field can be used to define the encoding of the files
1290 to be searched. The entered search text is converted to the chosen encoding
1291 and the search results are converted back to UTF-8.
1293 The *Extra options* field is used to pass any additional arguments to
1297 The *Files* setting uses ``--include=`` when searching recursively,
1298 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1299 not work with other Grep implementations.
1302 Filtering out version control files
1303 ```````````````````````````````````
1305 When using the *Recurse in subfolders* option with a directory that's
1306 under version control, you can set the *Extra options* field to filter
1307 out version control files.
1309 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1310 argument to filter out CVS and hidden directories like ``.svn``.
1312 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1314 If you have an older Grep, you can try using the ``--exclude`` flag
1315 to filter out filenames.
1317 SVN Example: ``--exclude=*.svn-base``
1319 The --exclude argument only matches the file name part, not the path.
1325 The Replace dialog is used for replacing text in one or more open
1328 .. image:: ./images/replace_dialog.png
1330 The Replace dialog has the same options for matching text as the Find
1331 dialog. See the section `Matching options`_.
1333 The *Use regular expressions* option allows regular expressions to
1334 be used in the search string and back references in the replacement
1335 text -- see the entry for '\\n' in `Regular expressions`_.
1340 To replace several matches, click on the *Replace All* expander. This
1341 will reveal several options:
1347 *Replace All In Document* will replace all matching text in the
1348 current document. *Replace All In Session* does the same for all open
1349 documents. *Replace All In Selection* will replace all matching text
1350 in the current selection of the current document.
1353 Go to symbol definition
1354 ^^^^^^^^^^^^^^^^^^^^^^^
1356 If the current word or selection is the name of a symbol definition
1357 (e.g. a function name) and the file containing the symbol definition is
1358 open, this command will switch to that file and go to the
1359 corresponding line number. The current word is either the word
1360 nearest the edit cursor, or the word underneath the popup menu click
1361 position when the popup menu is used.
1363 If there are more symbols with the same name to which the goto can be performed,
1364 a pop up is shown with a list of all the occurrences. After selecting a symbol
1365 from the list Geany jumps to the corresponding symbol location. Geany tries to
1366 suggest the nearest symbol (symbol from the current file, other open documents
1367 or current directory) as the best candidate for the goto and places this symbol
1368 at the beginning of the list typed in boldface.
1371 If the corresponding symbol is on the current line, Geany will first
1372 look for a symbol declaration instead, as this is more useful.
1373 Likewise *Go to symbol declaration* will search for a symbol definition
1374 first in this case also.
1377 Go to symbol declaration
1378 ^^^^^^^^^^^^^^^^^^^^^^^^
1380 Like *Go to symbol definition*, but for a forward declaration such as a
1381 C function prototype or ``extern`` declaration instead of a function
1388 Go to a particular line number in the current file.
1394 You can use regular expressions in the Find and Replace dialogs
1395 by selecting the *Use regular expressions* check box (see `Matching
1396 options`_). The syntax is Perl compatible. Basic syntax is described
1397 in the table below. For full details, see
1398 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1400 By default regular expressions are matched on a line-by-line basis.
1401 If you are interested in multi-line regular expressions, matched against
1402 the whole buffer at once, see the section `Multi-line regular expressions`_
1406 1. The *Use escape sequences* dialog option always applies for regular
1408 2. Searching backwards with regular expressions is not supported.
1409 3. The *Use multi-line matching* dialog option to select single or
1410 multi-line matching.
1412 **In a regular expression, the following characters are interpreted:**
1414 ======= ============================================================
1415 . Matches any character.
1417 ( This marks the start of a region for tagging a match.
1419 ) This marks the end of a tagged region.
1421 \\n Where n is 1 through 9 refers to the first through ninth tagged
1422 region when searching or replacing.
1424 Searching for (Wiki)\\1 matches WikiWiki.
1426 If the search string was Fred([1-9])XXX and the
1427 replace string was Sam\\1YYY, when applied to Fred2XXX this
1428 would generate Sam2YYY.
1430 \\0 When replacing, the whole matching text.
1432 \\b This matches a word boundary.
1434 \\c A backslash followed by d, D, s, S, w or W, becomes a
1435 character class (both inside and outside sets []).
1438 * D: any char except decimal digits
1439 * s: whitespace (space, \\t \\n \\r \\f \\v)
1440 * S: any char except whitespace (see above)
1441 * w: alphanumeric & underscore
1442 * W: any char except alphanumeric & underscore
1444 \\x This allows you to use a character x that would otherwise have
1445 a special meaning. For example, \\[ would be interpreted as [
1446 and not as the start of a character set. Use \\\\ for a literal
1449 [...] Matches one of the characters in the set. If the first
1450 character in the set is ^, it matches the characters NOT in
1451 the set, i.e. complements the set. A shorthand S-E (start
1452 dash end) is used to specify a set of characters S up to E,
1455 The special characters ] and - have no special
1456 meaning if they appear first in the set. - can also be last
1457 in the set. To include both, put ] first: []A-Z-].
1461 []|-] matches these 3 chars
1462 []-|] matches from ] to | chars
1463 [a-z] any lowercase alpha
1464 [^]-] any char except - and ]
1465 [^A-Z] any char except uppercase alpha
1468 ^ This matches the start of a line (unless used inside a set, see
1471 $ This matches the end of a line.
1473 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1474 Saam, Saaam and so on.
1476 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1477 Saam, Saaam and so on.
1479 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1480 ======= ============================================================
1483 This table is adapted from Scintilla and SciTE documentation,
1484 distributed under the `License for Scintilla and SciTE`_.
1487 Multi-line regular expressions
1488 ``````````````````````````````
1491 The *Use multi-line matching* dialog option enables multi-line
1492 regular expressions.
1494 Multi-line regular expressions work just like single-line ones but a
1495 match can span several lines.
1497 While the syntax is the same, a few practical differences applies:
1499 ======= ============================================================
1500 . Matches any character but newlines. This behavior can be changed
1501 to also match newlines using the (?s) option, see
1502 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1504 [^...] A negative range (see above) *will* match newlines if they are
1505 not explicitly listed in that negative range. For example, range
1506 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1507 While this is the expected behavior, it can lead to tricky
1508 problems if one doesn't think about it when writing an expression.
1509 ======= ============================================================
1514 The View menu allows various elements of the main window to be shown
1515 or hidden, and also provides various display-related editor options.
1517 Color schemes dialog
1518 ^^^^^^^^^^^^^^^^^^^^
1519 The Color Schemes dialog is available under the *View->Change Color Scheme*
1520 menu item. It lists various color schemes for editor highlighting
1521 styles, including the default scheme first. Other items are available
1522 based on what color scheme files Geany found at startup.
1524 Color scheme files are read from the `Configuration file paths`_ under
1525 the ``colorschemes`` subdirectory. They should have the extension
1526 ``.conf``. The default color scheme
1527 is read from ``filetypes.common``.
1529 The `[named_styles] section`_ and `[named_colors] section`_ are the
1530 same as for ``filetypes.common``.
1532 The ``[theme_info]`` section can contain information about the
1533 theme. The ``name`` and ``description`` keys are read to set the
1534 menu item text and tooltip, respectively. These keys can have
1535 translations, e.g.::
1541 Symbols and tags files
1542 ----------------------
1544 Upon opening, files of supported filetypes are parsed to extract the symbol
1545 information (aka "workspace symbols"). You can also have Geany automatically
1546 load external files containing the symbol information (aka "global
1547 tags files") upon startup, or manually using *Tools --> Load Tags File*.
1549 Geany uses its own tags file format, similar to what ``ctags`` uses
1550 (but is incompatible with ctags). You use Geany to generate global
1551 tags files, as described below.
1557 Each document is parsed for symbols whenever a file is loaded, saved or
1558 modified (see *Symbol list update frequency* preference in the `Editor
1559 Completions preferences`_). These are shown in the Symbol list in the
1560 Sidebar. These symbols are also used for autocompletion and calltips
1561 for all documents open in the current session that have the same filetype.
1563 The *Go to Symbol* commands can be used with all workspace symbols. See
1564 `Go to symbol definition`_.
1570 Global tags files are used to provide symbols for autocompletion and calltips
1571 without having to open the source files containing these symbols. This is intended
1572 for library APIs, as the tags file only has to be updated when you upgrade
1575 You can load a custom global tags file in two ways:
1577 * Using the *Load Tags File* command in the Tools menu.
1578 * By moving or symlinking tags files to the ``tags`` subdirectory of
1579 one of the `configuration file paths`_ before starting Geany.
1581 You can either download these files or generate your own. They have
1586 *lang_ext* is one of the extensions set for the filetype associated
1587 with the tags parser. See the section called `Filetype extensions`_ for
1591 Default global tags files
1592 `````````````````````````
1594 Some global tags files are distributed with Geany and will be loaded
1595 automatically when the corresponding filetype is first used. Currently
1596 this includes global tags files for these languages:
1601 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1606 Global tags file format
1607 ```````````````````````
1609 Global tags files can have three different formats:
1612 * Pipe-separated format
1615 The first line of global tags files should be a comment, introduced
1616 by ``#`` followed by a space and a string like ``format=pipe``,
1617 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1618 case-sensitive. This helps Geany to read the file properly. If this
1619 line is missing, Geany tries to auto-detect the used format but this
1623 The Tagmanager format is a bit more complex and is used for files
1624 created by the ``geany -g`` command. There is one symbol per line.
1625 Different symbol attributes like the return value or the argument list
1626 are separated with different characters indicating the type of the
1627 following argument. This is the more complete and recommended tags file
1630 Pipe-separated format
1631 *********************
1632 The Pipe-separated format is easier to read and write.
1633 There is one symbol per line and different symbol attributes are separated
1634 by the pipe character (``|``). A line looks like::
1636 basename|string|(string path [, string suffix])|
1638 | The first field is the symbol name (usually a function name).
1639 | The second field is the type of the return value.
1640 | The third field is the argument list for this symbol.
1641 | The fourth field is the description for this symbol but
1642 currently unused and should be left empty.
1644 Except for the first field (symbol name), all other field can be left
1645 empty but the pipe separator must appear for them.
1647 You can easily write your own global tags files using this format.
1648 Just save them in your tags directory, as described earlier in the
1649 section `Global tags files`_.
1653 This is the format that ctags generates, and that is used by Vim.
1654 This format is compatible with the format historically used by Vi.
1656 The format is described at http://ctags.sourceforge.net/FORMAT, but
1657 for the full list of existing extensions please refer to ctags.
1658 However, note that Geany may actually only honor a subset of the
1659 existing extensions.
1661 Generating a global tags file
1662 `````````````````````````````
1664 You can generate your own global tags files by parsing a list of
1665 source files. The command is::
1667 geany -g [-P] <Tags File> <File list>
1669 * Tags File filename should be in the format described earlier --
1670 see the section called `Global tags files`_.
1671 * File list is a list of filenames, each with a full path (unless
1672 you are generating C/C++ tags files and have set the CFLAGS environment
1673 variable appropriately).
1674 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1675 to process ``#include`` directives for C/C++ source files. Use this
1676 option if you want to specify each source file on the command-line
1677 instead of using a 'master' header file. Also can be useful if you
1678 don't want to specify the CFLAGS environment variable.
1680 Example for the wxD library for the D programming language::
1682 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1685 Generating C/C++ tags files
1686 ***************************
1687 You may need to first setup the `C ignore.tags`_ file.
1689 For C/C++ tags files gcc is required by default, so that header files
1690 can be preprocessed to include any other headers they depend upon. If
1691 you do not want this, use the ``-P`` option described above.
1693 For preprocessing, the environment variable CFLAGS should be set with
1694 appropriate ``-I/path`` include paths. The following example works with
1695 the bash shell, generating a tags file for the GnomeUI library::
1697 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1698 /usr/include/libgnomeui-2.0/gnome.h
1700 You can adapt this command to use CFLAGS and header files appropriate
1701 for whichever libraries you want.
1704 Generating tags files on Windows
1705 ********************************
1706 This works basically the same as on other platforms::
1708 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1714 You can ignore certain symbols for C-based languages if they would lead
1715 to wrong parsing of the code. Use the *Tools->Configuration
1716 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1717 See also `Configuration file paths`_.
1719 List all symbol names you want to ignore in this file, separated by spaces
1724 G_GNUC_NULL_TERMINATED
1726 G_GNUC_WARN_UNUSED_RESULT
1728 This will parse code like:
1730 ``gchar **utils_strv_new(const gchar *first, ...)
1731 G_GNUC_NULL_TERMINATED;``
1733 More detailed information about ignore.tags usage from the Exuberant Ctags
1736 Specifies a list of identifiers which are to be specially handled
1737 while parsing C and C++ source files. This option is specifically
1738 provided to handle special cases arising through the use of
1739 pre-processor macros. When the identifiers listed are simple identifiers,
1740 these identifiers will be ignored during parsing of the source files.
1741 If an identifier is suffixed with a '+' character, ctags will also
1742 ignore any parenthesis-enclosed argument list which may immediately
1743 follow the identifier in the source files.
1744 If two identifiers are separated with the '=' character, the first
1745 identifiers is replaced by the second identifiers for parsing purposes.
1747 For even more detailed information please read the manual page of
1750 Geany extends Ctags with a '*' character suffix - this means use
1751 prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
1752 Note that prefix match items should be put after other items to ensure
1753 that items like G_GNUC_PRINTF+ get parsed correctly.
1759 You may adjust Geany's settings using the Edit --> Preferences
1760 dialog. Any changes you make there can be applied by hitting either
1761 the Apply or the OK button. These settings will persist between Geany
1762 sessions. Note that most settings here have descriptive popup bubble
1763 help -- just hover the mouse over the item in question to get help
1766 You may also adjust some View settings (under the View menu) that
1767 persist between Geany sessions. The settings under the Document menu,
1768 however, are only for the current document and revert to defaults
1769 when restarting Geany.
1772 In the paragraphs that follow, the text describing a dialog tab
1773 comes after the screenshot of that tab.
1776 General Startup preferences
1777 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1779 .. image:: ./images/pref_dialog_gen_startup.png
1784 Load files from the last session
1785 On startup, load the same files you had open the last time you
1788 Load virtual terminal support
1789 Load the library for running a terminal in the message window area.
1791 Enable plugin support
1792 Allow plugins to be used in Geany.
1796 Save window position and geometry
1797 Save the current position and size of the main window so next time
1798 you open Geany it's in the same location.
1801 Have a dialog pop up to confirm that you really want to quit Geany.
1807 Path to start in when opening or saving files.
1808 It must be an absolute path.
1811 Path to start in when opening project files.
1814 By default Geany looks in the system installation and the user
1815 configuration - see `Plugins`_. In addition the path entered here will be
1817 Usually you do not need to set an additional path to search for
1818 plugins. It might be useful when Geany is installed on a multi-user machine
1819 and additional plugins are available in a common location for all users.
1820 Leave blank to not set an additional lookup path.
1823 General Miscellaneous preferences
1824 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1826 .. image:: ./images/pref_dialog_gen_misc.png
1831 Beep on errors when compilation has finished
1832 Have the computer make a beeping sound when compilation of your program
1833 has completed or any errors occurred.
1835 Switch status message list at new message
1836 Switch to the status message tab (in the notebook window at the bottom)
1837 once a new status message arrives.
1839 Suppress status messages in the status bar
1840 Remove all messages from the status bar. The messages are still displayed
1841 in the status messages window.
1844 Another option is to use the *Switch to Editor* keybinding - it
1845 reshows the document statistics on the status bar. See `Focus
1848 Use Windows File Open/Save dialogs
1849 Defines whether to use the native Windows File Open/Save dialogs or
1850 whether to use the GTK default dialogs.
1852 Auto-focus widgets (focus follows mouse)
1853 Give the focus automatically to widgets below the mouse cursor.
1854 This works for the main editor widget, the scribble, the toolbar search field
1855 goto line fields and the VTE.
1861 Always wrap search around the document when finding a match.
1863 Hide the Find dialog
1864 Hide the `Find`_ dialog after clicking Find Next/Previous.
1866 Use the current word under the cursor for Find dialogs
1867 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1868 there is no selection. When this option is disabled, the search term last used in the
1869 appropriate Find dialog is used.
1871 Use the current file's directory for Find in Files
1872 When opening the Find in Files dialog, set the directory to search to the directory of the current
1873 active file. When this option is disabled, the directory of the last use of the Find in Files
1874 dialog is used. See `Find in Files`_ for details.
1879 Use project-based session files
1880 Save your current session when closing projects. You will be able to
1881 resume different project sessions, automatically opening the files
1882 you had open previously.
1884 Store project file inside the project base directory
1885 When creating new projects, the default path for the project file contains
1886 the project base path. Without this option enabled, the default project file
1887 path is one level above the project base path.
1888 In either case, you can easily set the final project file path in the
1889 *New Project* dialog. This option provides the more common
1890 defaults automatically for convenience.
1893 Interface preferences
1894 ^^^^^^^^^^^^^^^^^^^^^
1896 .. image:: ./images/pref_dialog_interface_interface.png
1902 Whether to show the sidebar at all.
1905 Show the list of functions, variables, and other information in the
1906 current document you are editing.
1909 Show all the documents you have open currently. This can be used to
1910 change between documents (see `Switching between documents`_) and
1911 to perform some common operations such as saving, closing and reloading.
1914 Whether to place the sidebar on the left or right of the editor window.
1920 Whether to place the message window on the bottom or right of the editor window.
1926 Change the font used to display documents.
1929 Change the font used for the Symbols sidebar tab.
1932 Change the font used for the message window area.
1938 Show the status bar at the bottom of the main window. It gives information about
1939 the file you are editing like the line and column you are on, whether any
1940 modifications were done, the file encoding, the filetype and other information.
1942 Interface Notebook tab preferences
1943 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1945 .. image:: ./images/pref_dialog_interface_notebook.png
1951 Show a notebook tab for all documents so you can switch between them
1952 using the mouse (instead of using the Documents window).
1955 Make each tab show a close button so you can easily close open
1958 Placement of new file tabs
1959 Whether to create a document with its notebook tab to the left or
1960 right of all existing tabs.
1963 Whether to place file tabs next to the current tab
1964 rather than at the edges of the notebook.
1966 Double-clicking hides all additional widgets
1967 Whether to call the View->Toggle All Additional Widgets command
1968 when double-clicking on a notebook tab.
1974 Set the positioning of the editor's notebook tabs to the right,
1975 left, top, or bottom of the editing window.
1978 Set the positioning of the sidebar's notebook tabs to the right,
1979 left, top, or bottom of the sidebar window.
1982 Set the positioning of the message window's notebook tabs to the
1983 right, left, top, or bottom of the message window.
1986 Interface Toolbar preferences
1987 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1989 Affects the main toolbar underneath the menu bar.
1991 .. image:: ./images/pref_dialog_interface_toolbar.png
1997 Whether to show the toolbar.
1999 Append Toolbar to the Menu
2000 Allows to append the toolbar to the main menu bar instead of placing it below.
2001 This is useful to save vertical space.
2004 See `Customizing the toolbar`_.
2010 Select the toolbar icon style to use - either icons and text, just
2012 The choice System default uses whatever icon style is set by GTK.
2015 Select the size of the icons you see (large, small or very small).
2016 The choice System default uses whatever icon size is set by GTK.
2019 Editor Features preferences
2020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2022 .. image:: ./images/pref_dialog_edit_features.png
2028 Show long lines wrapped around to new display lines.
2033 Whether to move the cursor to the first non-whitespace character
2034 on the line when you hit the home key on your keyboard. Pressing it
2035 again will go to the very start of the line.
2037 Disable Drag and Drop
2038 Do not allow the dragging and dropping of selected text in documents.
2041 Allow groups of lines in a document to be collapsed for easier
2044 Fold/Unfold all children of a fold point
2045 Whether to fold/unfold all child fold points when a parent line
2048 Use indicators to show compile errors
2049 Underline lines with compile errors using red squiggles to indicate
2050 them in the editor area.
2052 Newline strips trailing spaces
2053 Remove any whitespace at the end of the line when you hit the
2054 Enter/Return key. See also `Strip trailing spaces`_. Note
2055 auto indentation is calculated before stripping, so although this
2056 setting will clear a blank line, it will not set the next line
2057 indentation back to zero.
2059 Line breaking column
2060 The editor column number to insert a newline at when Line Breaking
2061 is enabled for the current document.
2063 Comment toggle marker
2064 A string which is added when toggling a line comment in a source file.
2065 It is used to mark the comment as toggled.
2068 Editor Indentation preferences
2069 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2071 .. image:: ./images/pref_dialog_edit_indentation.png
2076 See `Indentation`_ for more information.
2079 The width of a single indent size in spaces. By default the indent
2080 size is equivalent to 4 spaces.
2082 Detect width from file
2083 Try to detect and set the indent width based on file content, when
2087 When Geany inserts indentation, whether to use:
2091 * Tabs and Spaces, depending on how much indentation is on a line
2093 The *Tabs and Spaces* indent type is also known as *Soft tab
2094 support* in some other editors.
2096 Detect type from file
2097 Try to detect and set the indent type based on file content, when
2101 The type of auto-indentation you wish to use after pressing Enter,
2105 Just add the indentation of the previous line.
2107 Add indentation based on the current filetype and any characters at
2108 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2110 Like *Current chars* but for C-like languages, make a closing
2111 ``}`` brace line up with the matching opening brace.
2114 If set, pressing tab will indent the current line or selection, and
2115 unindent when pressing Shift-tab. Otherwise, the tab key will
2116 insert a tab character into the document (which can be different
2117 from indentation, depending on the indent type).
2120 There are also separate configurable keybindings for indent &
2121 unindent, but this preference allows the tab key to have different
2122 meanings in different contexts - e.g. for snippet completion.
2124 Editor Completions preferences
2125 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2127 .. image:: ./images/pref_dialog_edit_completions.png
2133 Whether to replace special keywords after typing Tab into a
2134 pre-defined text snippet.
2135 See `User-definable snippets`_.
2137 XML/HTML tag auto-closing
2138 When you open an XML/HTML tag automatically generate its
2141 Automatic continuation multi-line comments
2142 Continue automatically multi-line comments in languages like C, C++
2143 and Java when a new line is entered inside such a comment.
2144 With this option enabled, Geany will insert a ``*`` on every new line
2145 inside a multi-line comment, for example when you press return in the
2149 * This is a C multi-line comment, press <Return>
2151 then Geany would insert::
2155 on the next line with the correct indentation based on the previous line,
2156 as long as the multi-line is not closed by ``*/``.
2158 Autocomplete symbols
2159 When you start to type a symbol name, look for the full string to
2160 allow it to be completed for you.
2162 Autocomplete all words in document
2163 When you start to type a word, Geany will search the whole document for
2164 words starting with the typed part to complete it, assuming there
2165 are no symbol names to show.
2167 Drop rest of word on completion
2168 Remove any word part to the right of the cursor when choosing a
2169 completion list item.
2171 Characters to type for autocompletion
2172 Number of characters of a word to type before autocompletion is
2175 Completion list height
2176 The number of rows to display for the autocompletion window.
2178 Max. symbol name suggestions
2179 The maximum number of items in the autocompletion list.
2181 Symbol list update frequency
2182 The minimum delay (in milliseconds) between two symbol list updates.
2184 This option determines how frequently the symbol list is updated for the
2185 current document. The smaller the delay, the more up-to-date the symbol
2186 list (and then the completions); but rebuilding the symbol list has a
2187 cost in performance, especially with large files.
2189 The default value is 250ms, which means the symbol list will be updated
2190 at most four times per second, even if the document changes continuously.
2192 A value of 0 disables automatic updates, so the symbol list will only be
2193 updated upon document saving.
2196 Auto-close quotes and brackets
2197 ``````````````````````````````
2199 Geany can automatically insert a closing bracket and quote characters when
2200 you open them. For instance, you type a ``(`` and Geany will automatically
2201 insert ``)``. With the following options, you can define for which
2202 characters this should work.
2205 Auto-close parenthesis when typing an opening one
2208 Auto-close curly brackets (braces) when typing an opening one
2211 Auto-close square brackets when typing an opening one
2214 Auto-close single quotes when typing an opening one
2217 Auto-close double quotes when typing an opening one
2220 Editor Display preferences
2221 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2223 This is for visual elements displayed in the editor window.
2225 .. image:: ./images/pref_dialog_edit_display.png
2230 Invert syntax highlighting colors
2231 Invert all colors, by default this makes white text on a black
2234 Show indendation guides
2235 Show vertical lines to help show how much leading indentation there
2239 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2240 show which kinds of whitespace are used.
2243 Display a symbol everywhere that a carriage return or line feed
2247 Show or hide the Line Number margin.
2250 Show or hide the small margin right of the line numbers, which is used
2253 Stop scrolling at last line
2254 When enabled Geany stops scrolling when at the last line of the document.
2255 Otherwise you can scroll one more page even if there are no real lines.
2261 The long line marker helps to indicate overly-long lines, or as a hint
2262 to the user for when to break the line.
2266 Show a thin vertical line in the editor window at the given column
2269 Change the background color of characters after the given column
2270 position to the color set below. (This is recommended over the
2271 *Line* setting if you use proportional fonts).
2273 Don't mark long lines at all.
2276 Set this value to a value greater than zero to specify the column
2277 where it should appear.
2279 Long line marker color
2280 Set the color of the long line marker.
2286 Virtual space is space beyond the end of each line.
2287 The cursor may be moved into virtual space but no real space will be
2288 added to the document until there is some text typed or some other
2289 text insertion command is used.
2292 Do not show virtual spaces
2294 Only for rectangular selections
2295 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2298 Always show virtual spaces beyond the end of lines
2304 .. image:: ./images/pref_dialog_files.png
2309 Open new documents from the command-line
2310 Whether to create new documents when passing filenames that don't
2311 exist from the command-line.
2313 Default encoding (new files)
2314 The type of file encoding you wish to use when creating files.
2316 Used fixed encoding when opening files
2317 Assume all files you are opening are using the type of encoding specified below.
2319 Default encoding (existing files)
2320 Opens all files with the specified encoding instead of auto-detecting it.
2321 Use this option when it's not possible for Geany to detect the exact encoding.
2323 Default end of line characters
2324 The end of line characters to which should be used for new files.
2325 On Windows systems, you generally want to use CR/LF which are the common
2326 characters to mark line breaks.
2327 On Unix-like systems, LF is default and CR is used on MAC systems.
2331 Perform formatting operations when a document is saved. These
2332 can each be undone with the Undo command.
2334 Ensure newline at file end
2335 Add a newline at the end of the document if one is missing.
2337 Ensure consistent line endings
2338 Ensures that newline characters always get converted before
2339 saving, avoiding mixed line endings in the same file.
2341 .. _Strip trailing spaces:
2343 Strip trailing spaces
2344 Remove any whitespace at the end of each document line.
2347 This does not apply to Diff documents, e.g. patch files.
2349 Replace tabs with spaces
2350 Replace all tabs in the document with the equivalent number of spaces.
2353 It is better to use spaces to indent than use this preference - see
2359 Recent files list length
2360 The number of files to remember in the recently used files list.
2363 The number of seconds to periodically check the current document's
2364 file on disk in case it has changed. Setting it to 0 will disable
2368 These checks are only performed on local files. Remote files are
2369 not checked for changes due to performance issues
2370 (remote files are files in ``~/.gvfs/``).
2376 .. image:: ./images/pref_dialog_tools.png
2382 The command to execute a script in a terminal. Occurrences of %c
2383 in the command are substituted with the run script name, see
2384 `Terminal emulators`_.
2387 The location of your web browser executable.
2390 The location of the grep executable.
2393 For Windows users: at the time of writing it is recommended to use
2394 the grep.exe from the UnxUtils project
2395 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2396 Mingw project for instance might not work with Geany at the moment.
2402 Set this to a command to execute on the current word.
2403 You can use the "%s" wildcard to pass the current word below the cursor
2404 to the specified command.
2407 Template preferences
2408 ^^^^^^^^^^^^^^^^^^^^
2410 This data is used as meta data for various template text to insert into
2411 a document, such as the file header. You only need to set fields that
2412 you want to use in your template files.
2414 .. image:: ./images/pref_dialog_templ.png
2420 The name of the developer who will be creating files.
2423 The initials of the developer.
2426 The email address of the developer.
2429 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2432 The company the developer is working for.
2435 The initial version of files you will be creating.
2438 Specify a format for the {year} wildcard. You can use any conversion specifiers
2439 which can be used with the ANSI C strftime function. For details please see
2440 http://man.cx/strftime.
2443 Specify a format for the {date} wildcard. You can use any conversion specifiers
2444 which can be used with the ANSI C strftime function. For details please see
2445 http://man.cx/strftime.
2448 Specify a format for the {datetime} wildcard. You can use any conversion specifiers
2449 which can be used with the ANSI C strftime function. For details please see
2450 http://man.cx/strftime.
2453 Keybinding preferences
2454 ^^^^^^^^^^^^^^^^^^^^^^
2456 .. image:: ./images/pref_dialog_keys.png
2458 There are some commands listed in the keybinding dialog that are not, by default,
2459 bound to a key combination, and may not be available as a menu item.
2462 For more information see the section `Keybindings`_.
2465 Printing preferences
2466 ^^^^^^^^^^^^^^^^^^^^
2468 .. image:: ./images/pref_dialog_printing.png
2470 Use external command for printing
2471 Use a system command to print your file out.
2473 Use native GTK printing
2474 Let the GTK GUI toolkit handle your print request.
2477 Print the line numbers on the left of your paper.
2480 Print the page number on the bottom right of your paper.
2483 Print a header on every page that is sent to the printer.
2485 Use base name of the printed file
2486 Don't use the entire path for the header, only the filename.
2489 How the date should be printed. You can use the same format
2490 specifiers as in the ANSI C function strftime(). For details please
2491 see http://man.cx/strftime.
2497 .. image:: ./images/pref_dialog_various.png
2499 Rarely used preferences, explained in the table below. A few of them require
2500 restart to take effect, and a few other will only affect newly opened or created
2501 documents before restart.
2503 ================================ =========================================== ========== ===========
2504 Key Description Default Applies
2505 ================================ =========================================== ========== ===========
2507 use_gtk_word_boundaries Whether to look for the end of a word true to new
2508 when using word-boundary related documents
2509 Scintilla commands (see `Scintilla
2510 keyboard commands`_).
2511 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2512 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2513 when editing an existing line (i.e. there
2514 is some text after the current cursor
2515 position on the line). Only used when the
2516 keybinding `Complete snippet` is set to
2518 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2519 false, the horizontal and vertical
2520 scrollbars are hidden completely.
2521 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2522 it unless you really need to; use the
2523 indentation settings instead.
2524 **Interface related**
2525 show_symbol_list_expanders Whether to show or hide the small true to new
2526 expander icons on the symbol list documents
2528 allow_always_save Whether files can be saved always, even false immediately
2529 if they don't have any changes.
2530 By default, the Save button and menu
2531 item are disabled when a file is
2532 unchanged. When setting this option to
2533 true, the Save button and menu item are
2534 always active and files can be saved.
2535 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2536 last line of the output in the Compiler
2538 statusbar_template The status bar statistics line format. See below. immediately
2539 (See `Statusbar Templates`_ for details).
2540 new_document_after_close Whether to open a new document after all false immediately
2541 documents have been closed.
2542 msgwin_status_visible Whether to show the Status tab in the true immediately
2544 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2546 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2548 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2551 emulation Terminal emulation mode. Only change this xterm immediately
2552 if you have VTE termcap files other than
2553 ``vte/termcap/xterm``.
2554 send_selection_unsafe By default, Geany strips any trailing false immediately
2555 newline characters from the current
2556 selection before sending it to the terminal
2557 to not execute arbitrary code. This is
2558 mainly a security feature.
2559 If, for whatever reasons, you really want
2560 it to be executed directly, set this option
2562 send_cmd_prefix String with which prefix the commands sent Empty immediately
2563 to the shell. This may be used to tell
2564 some shells (BASH with ``HISTCONTROL`` set
2565 to ``ignorespace``, ZSH with
2566 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2567 putting these commands in their history by
2568 setting this to a space. Note that leading
2569 spaces must be escaped using `\s` in the
2572 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2573 disk. If disabled, Geany directly writes
2574 the content of the document to disk. This
2575 might cause loss of data when there is
2576 no more free space on disk to save the
2577 file. When set to true, Geany first saves
2578 the contents into a temporary file and if
2579 this succeeded, the temporary file is
2580 moved to the real file to save.
2581 This gives better error checking in case of
2582 no more free disk space. But it also
2583 destroys hard links of the original file
2584 and its permissions (e.g. executable flags
2585 are reset). Use this with care as it can
2586 break things seriously.
2587 The better approach would be to ensure your
2588 disk won't run out of free space.
2589 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2590 saving backend. It is better on most
2591 situations but is known not to work
2592 correctly on some complex setups.
2593 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2594 saving. Backup is named `filename~`.
2595 keep_edit_history_on_reload Whether to maintain the edit history when true immediately
2596 reloading a file, and allow the operation
2598 **Filetype related**
2599 extract_filetype_regex Regex to extract filetype name from file See below. immediately
2600 via capture group one.
2602 find_selection_type See `Find selection`_. 0 immediately
2604 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2605 it will be activated when the Enter key is
2606 pressed while one of the text fields has
2608 **Build Menu related**
2609 number_ft_menu_items The maximum number of menu items in the 2 on restart
2610 filetype section of the Build menu.
2611 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2612 independent section of the Build menu.
2613 number_exec_menu_items The maximum number of menu items in the 2 on restart
2614 execute section of the Build menu.
2615 ================================ =========================================== ========== ===========
2617 The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
2622 The default statusbar template is (note ``\t`` = tab):
2624 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2626 Settings the preference to an empty string will also cause Geany to use this
2629 The following format characters are available for the statusbar template:
2631 ============ ===========================================================
2632 Placeholder Description
2633 ============ ===========================================================
2634 ``%l`` The current line number starting at 1
2635 ``%L`` The total number of lines
2636 ``%c`` The current column number starting at 0, including virtual
2638 ``%C`` The current column number starting at 1, including virtual
2640 ``%s`` The number of selected characters or if only whole lines
2641 selected, the number of selected lines.
2642 ``%n`` The number of selected characters, even if only whole lines
2644 ``%w`` Shows ``RO`` when the document is in read-only mode,
2645 otherwise shows whether the editor is in overtype (OVR)
2646 or insert (INS) mode.
2647 ``%t`` Shows the indentation mode, either tabs (TAB),
2648 spaces (SP) or both (T/S).
2649 ``%m`` Shows whether the document is modified (MOD) or nothing.
2650 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2651 ``%e`` The name of the document's encoding (ex. UTF-8).
2652 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2653 ``%S`` The name of the scope where the caret is located.
2654 ``%p`` The caret position in the entire document starting at 0.
2655 ``%r`` Shows whether the document is read-only (RO) or nothing.
2656 ``%Y`` The Scintilla style number at the caret position. This is
2657 useful if you're debugging color schemes or related code.
2658 ============ ===========================================================
2660 Terminal (VTE) preferences
2661 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2663 See also: `Virtual terminal emulator widget (VTE)`_.
2665 .. image:: ./images/pref_dialog_vte.png
2671 Select the font that will be used in the terminal emulation control.
2674 Select the font color.
2677 Select the background color of the terminal.
2680 Select the background image to show behind the terminal's text.
2683 The number of lines buffered so that you can scroll though the history.
2686 The location of the shell on your system.
2689 Scroll the terminal to the prompt line when pressing a key.
2692 Scroll the output down.
2695 Let the terminal cursor blink.
2697 Override Geany keybindings
2698 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2700 Disable menu shortcut key (F10 by default)
2701 Disable the menu shortcut when you are in the virtual terminal.
2703 Follow path of the current file
2704 Make the path of the terminal change according to the path of the
2707 Execute programs in VTE
2708 Execute programs in the virtual terminal instead of using the external
2709 terminal tool. Note that if you run multiple execute commands at once
2710 the output may become mixed together in the VTE.
2712 Don't use run script
2713 Don't use the simple run script which is usually used to display
2714 the exit status of the executed program.
2715 This can be useful if you already have a program running in the VTE
2716 like a Python console (e.g. ipython). Use this with care.
2722 Project management is optional in Geany. Currently it can be used for:
2724 * Storing and opening session files on a project basis.
2725 * Overriding default settings with project equivalents.
2726 * Configuring the Build menu on a project basis.
2728 A list of session files can be stored and opened with the project
2729 when the *Use project-based session files* preference is enabled,
2730 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2731 of the `Preferences`_ dialog.
2733 As long as a project is open, the Build menu will use
2734 the items defined in project's settings, instead of the defaults.
2735 See `Build Menu Configuration`_ for information on configuring the menu.
2737 The current project's settings are saved when it is closed, or when
2738 Geany is shutdown. When restarting Geany, the previously opened project
2739 file that was in use at the end of the last session will be reopened.
2741 The project menu items are detailed below.
2747 To create a new project, fill in the *Name* field. By default this
2748 will setup a new project file ``~/projects/name.geany``. Usually it's
2749 best to store all your project files in the same directory (they are
2750 independent of any source directory trees).
2752 The Base path text field is setup to use ``~/projects/name``. This
2753 can safely be set to any existing path -- it will not touch the file
2754 structure contained in it.
2760 You can set an optional description for the project. Currently it's
2761 only used for a template wildcard - see `Template wildcards`_.
2763 The *Base path* field is used as the directory to run the Build menu commands.
2764 The specified path can be an absolute path or it is considered to be
2765 relative to the project's file name.
2767 The *File patterns* field allows to specify a list of file patterns for the
2768 project, which can be used in the `Find in files`_ dialog.
2770 The *Indentation* tab allows you to override the default
2771 `Indentation`_ settings.
2777 The Open command displays a standard file chooser, starting in
2778 ``~/projects``. Choose a project file named with the ``.geany``
2781 When project session support is enabled, Geany will close the currently
2782 open files and open the session files associated with the project.
2788 Project file settings are saved when the project is closed.
2790 When project session support is enabled, Geany will close the project
2791 session files and open any previously closed default session files.
2796 After editing code with Geany, the next step is to compile, link, build,
2797 interpret, run etc. As Geany supports many languages each with a different
2798 approach to such operations, and as there are also many language independent
2799 software building systems, Geany does not have a built-in build system, nor
2800 does it limit which system you can use. Instead the build menu provides
2801 a configurable and flexible means of running any external commands to
2802 execute your preferred build system.
2804 This section provides a description of the default configuration of the
2805 build menu and then covers how to configure it, and where the defaults fit in.
2807 Running the commands from within Geany has two benefits:
2809 * The current file is automatically saved before the command is run.
2810 * The output is captured in the Compiler notebook tab and parsed for
2813 Warnings and errors that can be parsed for line numbers will be shown in
2814 red in the Compiler tab and you can click on them to switch to the relevant
2815 source file (or open it) and mark the line number. Also lines with
2816 warnings or errors are marked in the source, see `Indicators`_ below.
2819 If Geany's default error message parsing does not parse errors for
2820 the tool you're using, you can set a custom regex in the Build Commands
2821 Dialog, see `Build Menu Configuration`_.
2826 Indicators are red squiggly underlines which are used to highlight
2827 errors which occurred while compiling the current file. So you can
2828 easily see where your code failed to compile. You can remove them by
2829 selecting *Remove Error Indicators* in the Document menu.
2831 If you do not like this feature, you can disable it - see `Editor Features
2835 Default build menu items
2836 ^^^^^^^^^^^^^^^^^^^^^^^^
2837 Depending on the current file's filetype, the default Build menu will contain
2838 the following items:
2844 * Make Custom Target
2849 * Set Build Menu Commands
2855 The Compile command has different uses for different kinds of files.
2857 For compilable languages such as C and C++, the Compile command is
2858 set up to compile the current source file into a binary object file.
2860 Java source files will be compiled to class file bytecode.
2862 Interpreted languages such as Perl, Python, Ruby will compile to
2863 bytecode if the language supports it, or will run a syntax check,
2864 or if that is not available will run the file in its language interpreter.
2869 For compilable languages such as C and C++, the Build command will link
2870 the current source file's equivalent object file into an executable. If
2871 the object file does not exist, the source will be compiled and linked
2872 in one step, producing just the executable binary.
2874 Interpreted languages do not use the Build command.
2877 If you need complex settings for your build system, or several
2878 different settings, then writing a Makefile and using the Make
2879 commands is recommended; this will also make it easier for users to
2880 build your software.
2885 Source code linters are often used to find code that doesn't correspond to
2886 certain style guidelines: non-portable code, common or hard to find
2887 errors, code "smells", variables used before being set, unused functions,
2888 division by zero, constant conditions, etc. Linters inspect the code and
2889 issue warnings much like the compilers do. This is formally referred to as
2890 static code analysis.
2892 Some common linters are pre-configured for you in the Build menu (``pep8``
2893 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2894 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2895 these are standalone tools you need to obtain before using.
2900 This runs "make" in the same directory as the
2906 This is similar to running 'Make' but you will be prompted for
2907 the make target name to be passed to the Make tool. For example,
2908 typing 'clean' in the dialog prompt will run "make clean".
2914 Make object will run "make current_file.o" in the same directory as
2915 the current file, using the filename for 'current_file'. It is useful
2916 for building just the current file without building the whole project.
2921 The next error item will move to the next detected error in the file.
2925 The previous error item will move to the previous detected error in the file.
2930 Execute will run the corresponding executable file, shell script or
2931 interpreted script in a terminal window. The command set in the
2932 "Set Build Commands" dialog is run in a script to ensure the terminal
2933 stays open after execution completes. Note: see `Terminal emulators`_
2934 below for the command format. Alternatively the built-in VTE can be used
2935 if it is available - see `Virtual terminal emulator widget (VTE)`_.
2937 After your program or script has finished executing, the run script will
2938 prompt you to press the return key. This allows you to review any text
2939 output from the program before the terminal window is closed.
2942 The execute command output is not parsed for errors.
2945 Stopping running processes
2946 ``````````````````````````
2948 When there is a running program, the Execute menu item in the menu and
2949 the Run button in the toolbar
2950 each become a stop button so you can stop the current running program (and
2951 any child processes). This works by sending the SIGQUIT signal to the process.
2953 Depending on the process you started it is possible that the process
2954 cannot be stopped. For example this can happen when the process creates
2955 more than one child process.
2961 The Terminal field of the tools preferences tab requires a command to
2962 execute the terminal program and to pass it the name of the Geany run
2963 script that it should execute in a Bourne compatible shell (eg /bin/sh).
2964 The marker "%c" is substituted with the name of the Geany run script,
2965 which is created in the temporary directory and which changes the working
2966 directory to the directory set in the Build commands dialog, see
2967 `Build menu commands dialog`_ for details.
2969 As an example the default (Linux) command is::
2971 xterm -e "/bin/sh %c"
2977 By default Compile, Build and Execute are fairly basic commands. You
2978 may wish to customise them using *Set Build Commands*.
2980 E.g. for C you can add any include paths and compile flags for the
2981 compiler, any library names and paths for the linker, and any
2982 arguments you want to use when running Execute.
2984 Build menu configuration
2985 ^^^^^^^^^^^^^^^^^^^^^^^^
2987 The build menu has considerable flexibility and configurability, allowing
2988 both menu labels the commands they execute and the directory they execute
2989 in to be configured.
2991 For example, if you change one of the default make commands to run say 'waf'
2992 you can also change the label to match.
2994 These settings are saved automatically when Geany is shut down.
2996 The build menu is divided into four groups of items each with different
2999 * Filetype build commands - are configurable and depend on the filetype of the
3000 current document; they capture output in the compiler tab and parse it for
3002 * Independent build commands - are configurable and mostly don't depend on the
3003 filetype of the current document; they also capture output in the
3004 compiler tab and parse it for errors.
3005 * Execute commands - are configurable and intended for executing your
3006 program or other long running programs. The output is not parsed for errors
3007 and is directed to the terminal command selected in preferences.
3008 * Fixed commands - these perform built-in actions:
3010 * Go to the next error.
3011 * Go to the previous error.
3012 * Show the build menu commands dialog.
3014 The maximum numbers of items in each of the configurable groups can be
3015 configured in the `Various preferences`_. Even though the maximum number of
3016 items may have been increased, only those menu items that have values
3017 configured are shown in the menu.
3019 The groups of menu items obtain their configuration from four potential
3020 sources. The highest priority source that has the menu item defined will
3021 be used. The sources in decreasing priority are:
3023 * A project file if open
3024 * The user preferences
3025 * The system filetype definitions
3028 The detailed relationships between sources and the configurable menu item groups
3029 is shown in the following table.
3031 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3032 | Group | Project File | Preferences | System Filetype | Defaults |
3033 +==============+=====================+==========================+===================+===============================+
3034 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3035 | | file | filetypes.xxx file in | filetypes.xxx in | |
3036 | | | ~/.config/geany/filedefs | Geany install | |
3037 | | Saves To: project | | | |
3038 | | file | Saves to: as above, | Saves to: as user | |
3039 | | | creating if needed. | preferences left. | |
3040 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3041 | Filetype | Loads From: project | Loads From: | Loads From: | 1: |
3042 | Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3043 | | | ~/.config/geany | Geany install | Command: make |
3044 | | Saves To: project | | | |
3045 | | file | Saves to: as above, | Saves to: as user | 2: |
3046 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3047 | | | | | Command: make |
3050 | | | | | Label: Make _Object |
3051 | | | | | Command: make %e.o |
3052 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3053 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3054 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3055 | | filetype defined in | ~/.config/geany or else | Geany install | |
3056 | | project file | filetypes.xxx file in | | |
3057 | | | ~/.config/geany/filedefs | Saves To: as user | |
3058 | | Saves To: | | preferences left. | |
3059 | | project file | Saves To: | | |
3060 | | | filetypes.xxx file in | | |
3061 | | | ~/.config/geany/filedefs | | |
3062 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3064 The following notes on the table reference cells by coordinate as (group,source):
3066 * General - for filetypes.xxx substitute the appropriate extension for
3067 the filetype of the current document for xxx - see `filenames`_.
3069 * System Filetypes - Labels loaded from these sources are locale sensitive
3070 and can contain translations.
3072 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3073 filetype file so that users can configure all other filetype preferences
3074 as well. Projects can only configure menu items per filetype. Saving
3075 in the project file means that there is only one file per project not
3078 * (Filetype-Independent, System Filetype) - although conceptually strange, defining
3079 filetype-independent commands in a filetype file, this provides the ability to
3080 define filetype dependent default menu items.
3082 * (Execute, Project File) and (Execute, Preferences) - the project independent
3083 execute and preferences independent execute commands can only be set by hand
3084 editing the appropriate file, see `Preferences file format`_ and `Project file
3087 Build menu commands dialog
3088 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3090 Most of the configuration of the build menu is done through the Build Menu
3091 Commands Dialog. You edit the configuration sourced from preferences in the
3092 dialog opened from the Build->Build Menu Commands item and you edit the
3093 configuration from the project in the build tab of the project preferences
3094 dialog. Both use the same form shown below.
3096 .. image:: ./images/build_menu_commands_dialog.png
3098 The dialog is divided into three sections:
3100 * Filetype build commands (selected based on the current document's filetype).
3101 * Independent build commands (available regardless of filetype).
3102 * Filetype execute commands.
3104 The filetype and independent sections also each contain a field for the regular
3105 expression used for parsing command output for error and warning messages.
3107 The columns in the first three sections allow setting of the label, command,
3108 and working directory to run the command in.
3110 An item with an empty label will not be shown in the menu.
3112 An empty working directory will default to the directory of the current document.
3113 If there is no current document then the command will not run.
3115 The dialog will always show the command selected by priority, not just the
3116 commands configured in this configuration source. This ensures that you always
3117 see what the menu item is going to do if activated.
3119 If the current source of the menu item is higher priority than the
3120 configuration source you are editing then the command will be shown
3121 in the dialog but will be insensitive (greyed out). This can't happen
3122 with the project source but can with the preferences source dialog.
3124 The clear buttons remove the definition from the configuration source you are editing.
3125 When you do this the command from the next lower priority source will be shown.
3126 To hide lower priority menu items without having anything show in the menu
3127 configure with a nothing in the label but at least one character in the command.
3129 Substitutions in commands and working directories
3130 `````````````````````````````````````````````````
3132 The first occurrence of each of the following character sequences in each of the
3133 command and working directory fields is substituted by the items specified below
3134 before the command is run.
3136 * %d - substituted by the absolute path to the directory of the current file.
3137 * %e - substituted by the name of the current file without the extension or path.
3138 * %f - substituted by the name of the current file without the path.
3139 * %p - if a project is open, substituted by the base path from the project.
3140 * %l - substituted by the line number at the current cursor position.
3143 If the basepath set in the project preferences is not an absolute path , then it is
3144 taken as relative to the directory of the project file. This allows a project file
3145 stored in the source tree to specify all commands and working directories relative
3146 to the tree itself, so that the whole tree including the project file, can be moved
3147 and even checked into and out of version control without having to re-configure the
3150 Build menu keyboard shortcuts
3151 `````````````````````````````
3153 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3154 independent menu items, the first execute menu item and the fixed menu items.
3155 In the keybindings configuration dialog (see `Keybinding preferences`_)
3156 these items are identified by the default labels shown in the `Build Menu`_ section above.
3158 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3160 You can also use underlines in the labels to set mnemonic characters.
3165 The configurable Build Menu capability was introduced in Geany 0.19 and
3166 required a new section to be added to the configuration files (See
3167 `Preferences file format`_). Geany will still load older format project,
3168 preferences and filetype file settings and will attempt to map them into the new
3169 configuration format. There is not a simple clean mapping between the formats.
3170 The mapping used produces the most sensible results for the majority of cases.
3171 However, if they do not map the way you want, you may have to manually
3172 configure some settings using the Build Commands
3173 Dialog or the Build tab of the project preferences dialog.
3175 Any setting configured in either of these dialogs will override settings mapped from
3176 older format configuration files.
3181 Since Geany 0.13 there has been printing support using GTK's printing API.
3182 The printed page(s) will look nearly the same as on your screen in Geany.
3183 Additionally, there are some options to modify the printed page(s).
3186 The background text color is set to white, except for text with
3187 a white foreground. This allows dark color schemes to save ink
3190 You can define whether to print line numbers, page numbers at the bottom of
3191 each page and whether to print a page header on each page. This header
3192 contains the filename of the printed document, the current page number and
3193 the date and time of printing. By default, the file name of the document
3194 with full path information is added to the header. If you prefer to add
3195 only the basename of the file(without any path information) you can set it
3196 in the preferences dialog. You can also adjust the format of the date and
3197 time added to the page header. The available conversion specifiers are the
3198 same as the ones which can be used with the ANSI C strftime function.
3200 All of these settings can also be changed in the print dialog just before
3201 actual printing is done.
3202 On Unix-like systems the provided print dialog offers a print preview. The
3203 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3204 for print preview. If you have not installed evince or just want to use
3205 another PDF viewer, you can change the program to use in the file
3206 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
3209 gtk-print-preview-command = "epdfview %f"
3211 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3212 as the print preview command.
3214 Geany also provides an alternative basic printing support using a custom
3215 print command. However, the printed document contains no syntax highlighting.
3216 You can adjust the command to which the filename is passed in the preferences
3217 dialog. The default command is::
3221 ``%f`` will be substituted by the filename of the current file. Geany
3222 will not show errors from the command itself, so you should make
3223 sure that it works before(e.g. by trying to execute it from the
3226 A nicer example, which many prefer is::
3228 % a2ps -1 --medium=A4 -o - %f | xfprint4
3230 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3231 gtklp or similar programs can be used.
3238 Plugins are loaded at startup, if the *Enable plugin support*
3239 general preference is set. There is also a command-line option,
3240 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3241 the following directories:
3243 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3244 * The ``lib`` subfolder of the installation path on Windows.
3245 * The ``plugins`` subfolder of the user configuration directory - see
3246 `Configuration file paths`_.
3247 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3249 Most plugins add menu items to the *Tools* menu when they are loaded.
3251 See also `Plugin documentation`_ for information about single plugins
3252 which are included in Geany.
3256 The Plugin Manager dialog lets you choose which plugins
3257 should be loaded at startup. You can also load and unload plugins on the
3258 fly using this dialog. Once you click the checkbox for a specific plugin
3259 in the dialog, it is loaded or unloaded according to its previous state.
3260 By default, no plugins are loaded at startup until you select some.
3261 You can also configure some plugin specific options if the plugin
3268 Geany supports the default keyboard shortcuts for the Scintilla
3269 editing widget. For a list of these commands, see `Scintilla
3270 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3271 by any custom keybindings with the same keyboard shortcut.
3277 There are some non-configurable bindings to switch between documents,
3278 listed below. These can also be overridden by custom keybindings.
3280 =============== ==================================
3282 =============== ==================================
3283 Alt-[1-9] Select left-most tab, from 1 to 9.
3284 Alt-0 Select right-most tab.
3285 =============== ==================================
3287 See also `Notebook tab keybindings`_.
3290 Configurable keybindings
3291 ^^^^^^^^^^^^^^^^^^^^^^^^
3293 For all actions listed below you can define your own keybindings. Open
3294 the Preferences dialog, select the desired action and click on
3295 change. In the resulting dialog you can press the key combination you
3296 want to assign to the action and it will be saved when you press OK.
3297 You can define only one key combination for each action and each key
3298 combination can only be defined for one action.
3300 The following tables list all customizable keyboard shortcuts, those
3301 which are common to many applications are marked with (C) after the
3306 =============================== ========================= ==================================================
3307 Action Default shortcut Description
3308 =============================== ========================= ==================================================
3309 New Ctrl-N (C) Creates a new file.
3311 Open Ctrl-O (C) Opens a file.
3313 Open selected file Ctrl-Shift-O Opens the selected filename.
3315 Re-open last closed tab Re-opens the last closed document tab.
3317 Save Ctrl-S (C) Saves the current file.
3319 Save As Saves the current file under a new name.
3321 Save all Ctrl-Shift-S Saves all open files.
3323 Close all Ctrl-Shift-W Closes all open files.
3325 Close Ctrl-W (C) Closes the current file.
3327 Reload file Ctrl-R (C) Reloads the current file.
3329 Print Ctrl-P (C) Prints the current file.
3331 Quit Ctrl-Q (C) Quits Geany.
3332 =============================== ========================= ==================================================
3337 =============================== ========================= ==================================================
3338 Action Default shortcut Description
3339 =============================== ========================= ==================================================
3340 Undo Ctrl-Z (C) Un-does the last action.
3342 Redo Ctrl-Y Re-does the last action.
3344 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3347 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3348 end of the current line.
3350 Delete to line start Ctrl-Shift-BackSpace Deletes from the beginning of the line to the
3351 current caret position.
3353 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3355 Transpose current line Transposes the current line with the previous one.
3357 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3358 view. The cursor position and or an existing
3359 selection will not be changed.
3361 Scroll up by one line Alt-Up Scrolls the view.
3363 Scroll down by one line Alt-Down Scrolls the view.
3365 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3366 symbol completion, it shows document word completion
3367 instead, even if it is not enabled for automatic
3368 completion. Likewise if no symbol suggestions are
3369 available, it shows document word completion.
3371 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3374 Complete snippet Tab If you type a construct like if or for and press
3375 this key, it will be completed with a matching
3378 Suppress snippet completion If you type a construct like if or for and press
3379 this key, it will not be completed, and a space or
3380 tab will be inserted, depending on what the
3381 construct completion keybinding is set to. For
3382 example, if you have set the construct completion
3383 keybinding to space, then setting this to
3384 Shift+space will prevent construct completion and
3387 Context Action Executes a command and passes the current word
3388 (near the cursor position) or selection as an
3389 argument. See the section called `Context
3392 Move cursor in snippet Jumps to the next defined cursor positions in a
3393 completed snippets if multiple cursor positions
3396 Word part completion Tab When the autocompletion list is visible, complete
3397 the currently selected item up to the next word
3400 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3403 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3405 =============================== ========================= ==================================================
3408 Clipboard keybindings
3409 `````````````````````
3410 =============================== ========================= ==================================================
3411 Action Default shortcut Description
3412 =============================== ========================= ==================================================
3413 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3415 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3417 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3419 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3420 selection) to the clipboard.
3422 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3423 selection) to the clipboard.
3424 =============================== ========================= ==================================================
3429 =============================== ========================= ==================================================
3430 Action Default shortcut Description
3431 =============================== ========================= ==================================================
3432 Select all Ctrl-A (C) Makes a selection of all text in the current
3435 Select current word Alt-Shift-W Selects the current word under the cursor.
3437 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3438 which is defined by two empty lines around it.
3440 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3441 partially selected lines).
3443 Select to previous word part (Extend) selection to previous word part boundary.
3445 Select to next word part (Extend) selection to next word part boundary.
3446 =============================== ========================= ==================================================
3451 =============================== ========================= ==================================================
3452 Action Default shortcut Description
3453 =============================== ========================= ==================================================
3454 Insert date Shift-Alt-D Inserts a customisable date.
3456 Insert alternative whitespace Inserts a tab character when spaces should
3457 be used for indentation and inserts space
3458 characters of the amount of a tab width when
3459 tabs should be used for indentation.
3461 Insert New Line Before Current Inserts a new line with indentation.
3463 Insert New Line After Current Inserts a new line with indentation.
3464 =============================== ========================= ==================================================
3469 =============================== ========================= ==================================================
3470 Action Default shortcut Description
3471 =============================== ========================= ==================================================
3472 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3473 selection will be changed into uppercase and vice
3474 versa. If the selection contains lower- and
3475 uppercase characters, all will be converted to
3478 Comment line Comments current line or selection.
3480 Uncomment line Uncomments current line or selection.
3482 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3483 a comment if the line is commented.
3485 Increase indent Ctrl-I Indents the current line or selection by one tab
3486 or with spaces in the amount of the tab width
3489 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3490 the tab width setting from the indentation of the
3491 current line or selection.
3493 Increase indent by one space Indents the current line or selection by one
3496 Decrease indent by one space Deindents the current line or selection by one
3499 Smart line indent Indents the current line or all selected lines
3500 with the same indentation as the previous line.
3502 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3503 external command (available for the first
3504 9 configured commands, see
3505 `Sending text through custom commands`_ for
3508 Send Selection to Terminal Sends the current selection or the current
3509 line (if there is no selection) to the
3510 embedded Terminal (VTE).
3512 Reflow lines/block Reformat selected lines or current
3513 (indented) text block,
3514 breaking lines at the long line marker or the
3515 line breaking column if line breaking is
3516 enabled for the current document.
3517 =============================== ========================= ==================================================
3520 Settings keybindings
3521 ````````````````````
3522 =============================== ========================= ==================================================
3523 Action Default shortcut Description
3524 =============================== ========================= ==================================================
3525 Preferences Ctrl-Alt-P Opens preferences dialog.
3527 Plugin Preferences Opens plugin preferences dialog.
3528 =============================== ========================= ==================================================
3533 =============================== ========================= ==================================================
3534 Action Default shortcut Description
3535 =============================== ========================= ==================================================
3536 Find Ctrl-F (C) Opens the Find dialog.
3538 Find Next Ctrl-G Finds next result.
3540 Find Previous Ctrl-Shift-G Finds previous result.
3542 Find Next Selection Finds next occurrence of selected text.
3544 Find Previous Selection Finds previous occurrence of selected text.
3546 Replace Ctrl-H (C) Opens the Replace dialog.
3548 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3550 Next message Jumps to the line with the next message in
3551 the Messages window.
3553 Previous message Jumps to the line with the previous message
3554 in the Messages window.
3556 Find Usage Ctrl-Shift-E Finds all occurrences of the current word (near
3557 the keyboard cursor) or selection in all open
3558 documents and displays them in the messages
3561 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word (near
3562 the keyboard cursor) or selection in the current
3563 document and displays them in the messages
3566 Mark All Ctrl-Shift-M Highlight all matches of the current
3567 word/selection in the current document
3568 with a colored box. If there's nothing to
3569 find, or the cursor is next to an existing match,
3570 the highlighted matches will be cleared.
3571 =============================== ========================= ==================================================
3576 =============================== ========================= ==================================================
3577 Action Default shortcut Description
3578 =============================== ========================= ==================================================
3579 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3580 history. See the section called `Code Navigation
3583 Navigate back a location Alt-Left (C) Switches to the previous location in the
3584 navigation history. See the section called
3585 `Code navigation history`_.
3587 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3588 shows the Go to line dialog.
3590 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3591 is moved to the brace which belongs to the current
3592 one. If this keyboard shortcut is pressed again,
3593 the cursor is moved back to the first brace.
3595 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3596 marker if there already is one.
3598 Goto next marker Ctrl-. Goto the next marker in the current document.
3600 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3602 Go to symbol definition Ctrl-T Jump to the definition of the current word or
3603 selection. See `Go to symbol definition`_.
3605 Go to symbol declaration Ctrl-Shift-T Jump to the declaration of the current word or
3606 selection. See `Go to symbol declaration`_.
3608 Go to Start of Line Home Move the caret to the start of the line.
3609 Behaves differently if smart_home_key_ is set.
3611 Go to End of Line End Move the caret to the end of the line.
3613 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3614 This is useful when you use line wrapping and
3615 want to jump to the start of the wrapped, virtual
3616 line, not the real start of the whole line.
3617 If the line is not wrapped, it behaves like
3618 `Go to Start of Line`.
3620 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3621 If the line is not wrapped, it behaves like
3622 `Go to End of Line`.
3624 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3626 Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
3627 =============================== ========================= ==================================================
3631 =============================== ========================= ==================================================
3632 Action Default shortcut Description
3633 =============================== ========================= ==================================================
3634 Fullscreen F11 (C) Switches to fullscreen mode.
3636 Toggle Messages Window Toggles the message window (status and compiler
3637 messages) on and off.
3639 Toggle Sidebar Shows or hides the sidebar.
3641 Toggle all additional widgets Hide and show all additional widgets like the
3642 notebook tabs, the toolbar, the messages window
3645 Zoom In Ctrl-+ (C) Zooms in the text.
3647 Zoom Out Ctrl-- (C) Zooms out the text.
3649 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3650 =============================== ========================= ==================================================
3654 ================================ ========================= ==================================================
3655 Action Default shortcut Description
3656 ================================ ========================= ==================================================
3657 Switch to Editor F2 Switches to editor widget.
3658 Also reshows the document statistics line
3659 (after a short timeout).
3661 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3664 Switch to Message Window Focus the Message Window's current tab.
3666 Switch to Compiler Focus the Compiler message window tab.
3668 Switch to Messages Focus the Messages message window tab.
3670 Switch to Scribble F6 Switches to scribble widget.
3672 Switch to VTE F4 Switches to VTE widget.
3674 Switch to Sidebar Focus the Sidebar.
3676 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3679 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3681 ================================ ========================= ==================================================
3684 Notebook tab keybindings
3685 ````````````````````````
3686 =============================== ========================= ==================================================
3687 Action Default shortcut Description
3688 =============================== ========================= ==================================================
3689 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3691 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3693 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3695 Holding Ctrl (or another modifier if the keybinding
3696 has been changed) will show a dialog, then repeated
3697 presses of the keybinding will switch to the 2nd-last
3698 used document, 3rd-last, etc. Also known as
3699 Most-Recently-Used documents switching.
3701 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3704 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3707 Move document first Moves the current document to the first position.
3709 Move document last Moves the current document to the last position.
3710 =============================== ========================= ==================================================
3713 Document keybindings
3714 ````````````````````
3715 ==================================== ==================== ==================================================
3716 Action Default shortcut Description
3717 ==================================== ==================== ==================================================
3718 Clone See `Cloning documents`_.
3720 Replace tabs with space Replaces all tabs with the right amount of spaces
3721 in the whole document, or the current selection.
3723 Replace spaces with tabs Replaces leading spaces with tab characters in the
3724 whole document, or the current selection.
3726 Toggle current fold Toggles the folding state of the current code block.
3728 Fold all Folds all contractible code blocks.
3730 Unfold all Unfolds all contracted code blocks.
3732 Reload symbol list Ctrl-Shift-R Reloads the symbol list.
3734 Toggle Line wrapping Enables or disables wrapping of long lines.
3736 Toggle Line breaking Enables or disables automatic breaking of long
3737 lines at a configurable column.
3739 Remove Markers Remove any markers on lines or words which
3740 were set by using 'Mark All' in the
3741 search dialog or by manually marking lines.
3743 Remove Error Indicators Remove any error indicators in the
3746 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3747 ``Remove Error Indicators``.
3748 ==================================== ==================== ==================================================
3753 =============================== ========================= ==================================================
3754 Action Default shortcut Description
3755 =============================== ========================= ==================================================
3756 New Create a new project.
3757 Open Opens a project file.
3758 Properties Shows project properties.
3759 Close Close the current project.
3760 =============================== ========================= ==================================================
3765 =============================== ========================= ==================================================
3766 Action Default shortcut Description
3767 =============================== ========================= ==================================================
3768 Compile F8 Compiles the current file.
3770 Build F9 Builds (compiles if necessary and links) the
3773 Make all Shift-F9 Builds the current file with the Make tool.
3775 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3778 Make object Shift-F8 Compiles the current file with the Make tool.
3780 Next error Jumps to the line with the next error from the
3783 Previous error Jumps to the line with the previous error from
3784 the last build process.
3786 Run F5 Executes the current file in a terminal emulation.
3788 Set Build Commands Opens the build commands dialog.
3789 =============================== ========================= ==================================================
3794 =============================== ========================= ==================================================
3795 Action Default shortcut Description
3796 =============================== ========================= ==================================================
3797 Show Color Chooser Opens the Color Chooser dialog.
3798 =============================== ========================= ==================================================
3803 =============================== ========================= ==================================================
3804 Action Default shortcut Description
3805 =============================== ========================= ==================================================
3806 Help F1 (C) Opens the manual.
3807 =============================== ========================= ==================================================
3815 You must use UTF-8 encoding *without BOM* for configuration files.
3818 Configuration file paths
3819 ------------------------
3820 Geany has default configuration files installed for the system and
3821 also per-user configuration files.
3823 The system files should not normally be edited because they will be
3824 overwritten when upgrading Geany.
3826 The user configuration directory can be overridden with the ``-c``
3827 switch, but this is not normally done. See `Command line options`_.
3830 Any missing subdirectories in the user configuration directory
3831 will be created when Geany starts.
3833 You can check the paths Geany is using with *Help->Debug Messages*.
3834 Near the top there should be 2 lines with something like::
3836 Geany-INFO: System data dir: /usr/share/geany
3837 Geany-INFO: User config dir: /home/username/.config/geany
3840 Paths on Unix-like systems
3841 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3842 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3843 path where Geany is installed (see `Installation prefix`_).
3845 The user configuration directory is normally:
3846 ``/home/username/.config/geany``
3850 The system path is the ``data`` subfolder of the installation path
3853 The user configuration directory might vary, but on Windows XP it's:
3854 ``C:\Documents and Settings\UserName\Application Data\geany``
3855 On Windows 7 and above you most likely will find it at:
3856 ``C:\users\UserName\Roaming\geany``
3861 There's a *Configuration files* submenu in the *Tools* menu that
3862 contains items for some of the available user configuration files.
3863 Clicking on one opens it in the editor for you to update. Geany will
3864 reload the file after you have saved it.
3867 Other configuration files not shown here will need to be opened
3868 manually, and will not be automatically reloaded when saved.
3869 (see *Reload Configuration* below).
3871 There's also a *Reload Configuration* item which can be used if you
3872 updated one of the other configuration files, or modified or added
3875 *Reload Configuration* is also necessary to update syntax highlighting colors.
3878 Syntax highlighting colors aren't updated in open documents after
3879 saving filetypes.common as this may take a significant
3883 Global configuration file
3884 -------------------------
3886 System administrators can add a global configuration file for Geany
3887 which will be used when starting Geany and a user configuration file
3890 The global configuration file is read from ``geany.conf`` in the
3891 system configuration path - see `Configuration file paths`_. It can
3892 contain any settings which are found in the usual configuration file
3893 created by Geany, but does not have to contain all settings.
3896 This feature is mainly intended for package maintainers or system
3897 admins who want to set up Geany in a multi user environment and
3898 set some sane default values for this environment. Usually users won't
3903 Filetype definition files
3904 -------------------------
3906 All color definitions and other filetype specific settings are
3907 stored in the filetype definition files. Those settings are colors
3908 for syntax highlighting, general settings like comment characters or
3909 word delimiter characters as well as compiler and linker settings.
3911 See also `Configuration file paths`_.
3915 Each filetype has a corresponding filetype definition file. The format
3916 for built-in filetype `Foo` is::
3920 The extension is normally just the filetype name in lower case.
3922 However there are some exceptions:
3924 =============== =========
3926 =============== =========
3930 Matlab/Octave matlab
3931 =============== =========
3933 There is also the `special file filetypes.common`_.
3935 For `custom filetypes`_, the filename for `Foo` is different::
3939 See the link for details.
3943 The system-wide filetype configuration files can be found in the
3944 system configuration path and are called ``filetypes.$ext``,
3945 where $ext is the name of the filetype. For every
3946 filetype there is a corresponding definition file. There is one
3947 exception: ``filetypes.common`` -- this file is for general settings,
3948 which are not specific to a certain filetype.
3951 It is not recommended that users edit the system-wide files,
3952 because they will be overridden when Geany is updated.
3956 To change the settings, copy a file from the system configuration
3957 path to the subdirectory ``filedefs`` in your user configuration
3958 directory. Then you can edit the file and the changes will still be
3959 available after an update of Geany.
3961 Alternatively, you can create the file yourself and add only the
3962 settings you want to change. All missing settings will be read from
3963 the corresponding system configuration file.
3967 At startup Geany looks for ``filetypes.*.conf`` files in the system and
3968 user filetype paths, adding any filetypes found with the name matching
3969 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
3971 Custom filetypes are not as powerful as built-in filetypes, but
3972 support for the following has been implemented:
3974 * Recognizing and setting the filetype (after the user has manually updated
3975 the `filetype extensions`_ file).
3976 * `Filetype group membership`_.
3977 * Reading filetype settings in the ``[settings]`` section, including:
3978 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
3979 * Using an existing tags parser (`tag_parser`_ key).
3980 * Build commands (``[build-menu]`` section).
3981 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
3983 See `Filetype configuration`_ for details on each setting.
3985 Creating a custom filetype from an existing filetype
3986 ````````````````````````````````````````````````````
3987 Because most filetype settings will relate to the syntax
3988 highlighting (e.g. styling, keywords, ``lexer_properties``
3989 sections), it is best to copy an existing filetype file that uses
3990 the lexer you wish to use as the basis of a custom filetype, using
3991 the correct filename extension format shown above, e.g.::
3993 cp filetypes.foo filetypes.Bar.conf
3995 Then add the ``lexer_filetype=Foo`` setting (if not already present)
3996 and add/adjust other settings.
3999 The ``[styling]`` and ``[keywords]`` sections have key names
4000 specific to each filetype/lexer. You must follow the same
4001 names - in particular, some lexers only support one keyword
4005 Filetype configuration
4006 ^^^^^^^^^^^^^^^^^^^^^^
4008 As well as the sections listed below, each filetype file can contain
4009 a [build-menu] section as described in `[build-menu] section`_.
4014 In this section the colors for syntax highlighting are defined. The
4017 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4019 Colors have to be specified as RGB hex values prefixed by
4020 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4021 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4022 values are case-insensitive but it is a good idea to use lower-case.
4023 Note that you can also use *named colors* as well by substituting the
4024 color value with the name of a color as defined in the ``[named_colors]``
4025 section, see the `[named_colors] Section`_ for more information.
4027 Bold and italic are flags and should only be "true" or "false". If their
4028 value is something other than "true" or "false", "false" is assumed.
4030 You can omit fields to use the values from the style named ``"default"``.
4032 E.g. ``key=0xff0000;;true``
4034 This makes the key style have red foreground text, default background
4035 color text and bold emphasis.
4039 The second format uses a *named style* name to reference a style
4040 defined in filetypes.common.
4042 * ``key=named_style``
4043 * ``key2=named_style2,bold,italic``
4045 The bold and italic parts are optional, and if present are used to
4046 toggle the bold or italic flags to the opposite of the named style's
4047 flags. In contrast to style definition booleans, they are a literal
4048 ",bold,italic" and commas are used instead of semi-colons.
4050 E.g. ``key=comment,italic``
4052 This makes the key style match the ``"comment"`` named style, but with
4055 To define named styles, see the filetypes.common `[named_styles]
4058 Reading styles from another filetype
4059 ************************************
4060 You can automatically copy all of the styles from another filetype
4061 definition file by using the following syntax for the ``[styling]``
4066 Where Foo is a filetype name. The corresponding ``[styling]``
4067 section from ``filetypes.foo`` will be read.
4069 This is useful when the same lexer is being used for multiple
4070 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4071 styling the same as the C styling, you would put the following in
4080 This section contains keys for different keyword lists specific to
4081 the filetype. Some filetypes do not support keywords, so adding a
4082 new key will not work. You can only add or remove keywords to/from
4086 The keywords list must be in one line without line ending characters.
4089 [lexer_properties] section
4090 ``````````````````````````
4091 Here any special properties for the Scintilla lexer can be set in the
4092 format ``key.name.field=some.value``.
4094 Properties Geany uses are listed in the system filetype files. To find
4095 other properties you need Geany's source code::
4097 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4104 This is the default file extension used when saving files, not
4105 including the period character (``.``). The extension used should
4106 match one of the patterns associated with that filetype (see
4107 `Filetype extensions`_).
4109 *Example:* ``extension=cxx``
4112 These characters define word boundaries when making selections
4113 and searching using word matching options.
4115 *Example:* (look at system filetypes.\* files)
4118 This overrides the *wordchars* filetypes.common setting, and
4119 has precedence over the *whitespace_chars* setting.
4122 A character or string which is used to comment code. If you want to use
4123 multiline comments only, don't set this but rather comment_open and
4126 Single-line comments are used in priority over multiline comments to
4127 comment a line, e.g. with the `Comment/Uncomment line` command.
4129 *Example:* ``comment_single=//``
4132 A character or string which is used to comment code. You need to also
4133 set comment_close to really use multiline comments. If you want to use
4134 single-line comments, prefer setting comment_single.
4136 Multiline comments are used in priority over single-line comments to
4137 comment a block, e.g. template comments.
4139 *Example:* ``comment_open=/*``
4142 If multiline comments are used, this is the character or string to
4145 *Example:* ``comment_close=*/``
4148 Set this to false if a comment character or string should start at
4149 column 0 of a line. If set to true it uses any indentation of the
4152 Note: Comment indentation
4154 ``comment_use_indent=true`` would generate this if a line is
4155 commented (e.g. with Ctrl-D)::
4159 ``comment_use_indent=false`` would generate this if a line is
4160 commented (e.g. with Ctrl-D)::
4162 # command_example();
4165 Note: This setting only works for single line comments (like '//',
4168 *Example:* ``comment_use_indent=true``
4171 A command which can be executed on the current word or the current
4174 Example usage: Open the API documentation for the
4175 current function call at the cursor position.
4178 be set for every filetype or if not set, a global command will
4179 be used. The command itself can be specified without the full
4180 path, then it is searched in $PATH. But for security reasons,
4181 it is recommended to specify the full path to the command. The
4182 wildcard %s will be replaced by the current word at the cursor
4183 position or by the current selection.
4185 Hint: for PHP files the following could be quite useful:
4186 context_action_cmd=firefox "http://www.php.net/%s"
4188 *Example:* ``context_action_cmd=devhelp -s "%s"``
4193 The TagManager language name, e.g. "C". Usually the same as the
4199 A filetype name to setup syntax highlighting from another filetype.
4200 This must not be recursive, i.e. it should be a filetype name that
4201 doesn't use the *lexer_filetype* key itself, e.g.::
4206 The second line is wrong, because ``filetypes.cpp`` itself uses
4207 ``lexer_filetype=C``, which would be recursive.
4209 symbol_list_sort_mode
4210 What the default symbol list sort order should be.
4212 ===== ========================================
4214 ===== ========================================
4215 0 Sort symbols by name
4216 1 Sort symbols by appearance (line number)
4217 ===== ========================================
4219 .. _xml_indent_tags:
4222 If this setting is set to *true*, a new line after a line ending with an
4223 unclosed XML/HTML tag will be automatically indented. This only applies
4224 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4225 this setting in their system configuration files.
4228 The MIME type for this file type, e.g. "text/x-csrc". This is used
4229 for example to chose the icon to display for this file type.
4232 [indentation] section
4233 `````````````````````
4235 This section allows definition of default indentation settings specific to
4236 the file type, overriding the ones configured in the preferences. This can
4237 be useful for file types requiring specific indentation settings (e.g. tabs
4238 only for Makefile). These settings don't override auto-detection if activated.
4241 The forced indentation width.
4244 The forced indentation type.
4246 ===== =======================
4247 Value Indentation type
4248 ===== =======================
4251 2 Mixed (tabs and spaces)
4252 ===== =======================
4255 [build_settings] section
4256 ````````````````````````
4258 As of Geany 0.19 this section is supplemented by the `[build-menu] section`_.
4259 Values that are set in the [build-menu] section will override those in this section.
4262 This is a Perl-compatible regular expression (PCRE) to parse a filename
4263 (absolute or relative) and line number from the build output.
4264 If undefined, Geany will fall back to its default error message parsing.
4266 Only the first two match groups will be read by Geany. These groups can
4267 occur in any order: the match group consisting of only digits will be used
4268 as the line number, and the other group as the filename. In no group
4269 consists of only digits, the match will fail.
4271 *Example:* ``error_regex=^(.+):([0-9]+):[0-9]+``
4273 This will parse a message such as:
4274 ``test.py:7:24: E202 whitespace before ']'``
4278 If any build menu item settings have been configured in the Build Menu Commands
4279 dialog or the Build tab of the project preferences dialog then these
4280 settings are stored in the [build-menu] section and override the settings in
4281 this section for that item.
4284 This item specifies the command to compile source code files. But
4285 it is also possible to use it with interpreted languages like Perl
4286 or Python. With these filetypes you can use this option as a kind of
4287 syntax parser, which sends output to the compiler message window.
4289 You should quote the filename to also support filenames with
4290 spaces. The following wildcards for filenames are available:
4292 * %f -- complete filename without path
4293 * %e -- filename without path and without extension
4295 *Example:* ``compiler=gcc -Wall -c "%f"``
4298 This item specifies the command to link the file. If the file is not
4299 already compiled, it will be compiled while linking. The -o option
4300 is automatically added by Geany. This item works well with GNU gcc,
4301 but may be problematic with other compilers (esp. with the linker).
4303 *Example:* ``linker=gcc -Wall "%f"``
4306 Use this item to execute your file. It has to have been built
4307 already. Use the %e wildcard to have only the name of the executable
4308 (i.e. without extension) or use the %f wildcard if you need the
4309 complete filename, e.g. for shell scripts.
4311 *Example:* ``run_cmd="./%e"``
4314 Special file filetypes.common
4315 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4317 There is a special filetype definition file called
4318 filetypes.common. This file defines some general non-filetype-specific
4321 You can open the user filetypes.common with the
4322 *Tools->Configuration Files->filetypes.common* menu item. This adds
4323 the default settings to the user file if the file doesn't exist.
4324 Alternatively the file can be created manually, adding only the
4325 settings you want to change. All missing settings will be read from
4329 See the `Filetype configuration`_ section for how to define styles.
4332 [named_styles] section
4333 ``````````````````````
4334 Named styles declared here can be used in the [styling] section of any
4339 *In filetypes.common*::
4342 foo=0xc00000;0xffffff;false;true
4350 This saves copying and pasting the whole style definition into several
4354 You can define aliases for named styles, as shown with the ``bar``
4355 entry in the above example, but they must be declared after the
4359 [named_colors] section
4360 ``````````````````````
4361 Named colors declared here can be used in the ``[styling]`` or
4362 ``[named_styles]`` section of any filetypes.* file or color scheme.
4367 my_red_color=#FF0000
4368 my_blue_color=#0000FF
4371 foo=my_red_color;my_blue_color;false;true
4373 This allows to define a color palette by name so that to change a color
4374 scheme-wide only involves changing the hex value in a single location.
4379 This is the default style. It is used for styling files without a
4382 *Example:* ``default=0x000000;0xffffff;false;false``
4385 The style for coloring selected text. The format is:
4389 * Use foreground color
4390 * Use background color
4392 The colors are only set if the 3rd or 4th argument is true. When
4393 the colors are not overridden, the default is a dark grey
4394 background with syntax highlighted foreground text.
4396 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4399 The style for brace highlighting when a matching brace was found.
4401 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4404 The style for brace highlighting when no matching brace was found.
4406 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4409 The style for coloring the caret(the blinking cursor). Only first
4410 and third argument is interpreted.
4411 Set the third argument to true to change the caret into a block caret.
4413 *Example:* ``caret=0x000000;0x0;false;false``
4416 The width for the caret(the blinking cursor). Only the first
4417 argument is interpreted. The width is specified in pixels with
4418 a maximum of three pixel. Use the width 0 to make the caret
4421 *Example:* ``caret_width=3``
4424 The style for coloring the background of the current line. Only
4425 the second and third arguments are interpreted. The second argument
4426 is the background color. Use the third argument to enable or
4427 disable background highlighting for the current line (has to be
4430 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4433 The style for coloring the indentation guides. Only the first and
4434 second arguments are interpreted.
4436 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4439 The style for coloring the white space if it is shown. The first
4440 both arguments define the foreground and background colors, the
4441 third argument sets whether to use the defined foreground color
4442 or to use the color defined by each filetype for the white space.
4443 The fourth argument defines whether to use the background color.
4445 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4448 Line number margin foreground and background colors.
4450 .. _Folding Settings:
4453 Fold margin foreground and background colors.
4455 fold_symbol_highlight
4456 Highlight color of folding symbols.
4459 The style of folding icons. Only first and second arguments are
4462 Valid values for the first argument are:
4469 Valid values for the second argument are:
4472 * 1 -- for straight lines
4473 * 2 -- for curved lines
4475 *Default:* ``folding_style=1;1;``
4477 *Arrows:* ``folding_style=3;0;``
4480 Draw a thin horizontal line at the line where text is folded. Only
4481 first argument is used.
4483 Valid values for the first argument are:
4485 * 0 -- disable, do not draw a line
4486 * 1 -- draw the line above folded text
4487 * 2 -- draw the line below folded text
4489 *Example:* ``folding_horiz_line=0;0;false;false``
4492 First argument: drawing of visual flags to indicate a line is wrapped.
4493 This is a bitmask of the values:
4495 * 0 -- No visual flags
4496 * 1 -- Visual flag at end of subline of a wrapped line
4497 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4498 indented by at least 1 to make room for the flag.
4500 Second argument: wether the visual flags to indicate a line is wrapped
4501 are drawn near the border or near the text. This is a bitmask of the values:
4503 * 0 -- Visual flags drawn near border
4504 * 1 -- Visual flag at end of subline drawn near text
4505 * 2 -- Visual flag at begin of subline drawn near text
4507 Only first and second arguments are interpreted.
4509 *Example:* ``line_wrap_visuals=3;0;false;false``
4512 First argument: sets the size of indentation of sublines for wrapped lines
4513 in terms of the width of a space, only used when the second argument is ``0``.
4515 Second argument: wrapped sublines can be indented to the position of their
4516 first subline or one more indent level. Possible values:
4518 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4519 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4520 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4522 Only first and second arguments are interpreted.
4524 *Example:* ``line_wrap_indent=0;1;false;false``
4527 Translucency for the current line (first argument) and the selection
4528 (second argument). Values between 0 and 256 are accepted.
4530 Note for Windows 95, 98 and ME users:
4531 keep this value at 256 to disable translucency otherwise Geany might crash.
4533 Only the first and second arguments are interpreted.
4535 *Example:* ``translucency=256;256;false;false``
4538 The style for a highlighted line (e.g when using Goto line or goto symbol).
4539 The foreground color (first argument) is only used when the Markers margin
4540 is enabled (see View menu).
4542 Only the first and second arguments are interpreted.
4544 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4547 The style for a marked search results (when using "Mark" in Search dialogs).
4548 The second argument sets the background color for the drawn rectangle.
4550 Only the second argument is interpreted.
4552 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4555 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4556 (Ctrl-M)). The foreground color (first argument) is only used
4557 when the Markers margin is enabled (see View menu).
4559 Only the first and second arguments are interpreted.
4561 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4564 Translucency for the line marker (first argument) and the search marker
4565 (second argument). Values between 0 and 256 are accepted.
4567 Note for Windows 95, 98 and ME users:
4568 keep this value at 256 to disable translucency otherwise Geany might crash.
4570 Only the first and second arguments are interpreted.
4572 *Example:* ``marker_translucency=256;256;false;false``
4575 Amount of space to be drawn above and below the line's baseline.
4576 The first argument defines the amount of space to be drawn above the line, the second
4577 argument defines the amount of space to be drawn below.
4579 Only the first and second arguments are interpreted.
4581 *Example:* ``line_height=0;0;false;false``
4584 The style for coloring the calltips. The first two arguments
4585 define the foreground and background colors, the third and fourth
4586 arguments set whether to use the defined colors.
4588 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4594 Characters to treat as whitespace. These characters are ignored
4595 when moving, selecting and deleting across word boundaries
4596 (see `Scintilla keyboard commands`_).
4598 This should include space (\\s) and tab (\\t).
4600 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4603 These characters define word boundaries when making selections
4604 and searching using word matching options.
4606 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4609 This has precedence over the *whitespace_chars* setting.
4617 To change the default filetype extension used when saving a new file,
4618 see `Filetype definition files`_.
4620 You can override the list of file extensions that Geany uses to detect
4621 filetypes using the user ``filetype_extensions.conf`` file. Use the
4622 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4623 also `Configuration file paths`_.
4625 You should only list lines for filetype extensions that you want to
4626 override in the user configuration file and remove or comment out
4627 others. The patterns are listed after the ``=`` sign, using a
4628 semi-colon separated list of patterns which should be matched for
4631 For example, to override the filetype extensions for Make, the file
4635 Make=Makefile*;*.mk;Buildfile;
4637 Filetype group membership
4638 ^^^^^^^^^^^^^^^^^^^^^^^^^
4639 Group membership is also stored in ``filetype_extensions.conf``. This
4640 file is used to store information Geany needs at startup, whereas the
4641 separate filetype definition files hold information only needed when
4642 a document with their filetype is used.
4644 The format looks like::
4653 The key names cannot be configured.
4656 Group membership is only read at startup.
4658 Preferences file format
4659 -----------------------
4661 The user preferences file ``geany.conf`` holds settings for all the items configured
4662 in the preferences dialog. This file should not be edited while Geany is running
4663 as the file will be overwritten when the preferences in Geany are changed or Geany
4667 [build-menu] section
4668 ^^^^^^^^^^^^^^^^^^^^
4670 The [build-menu] section contains the configuration of the build menu.
4671 This section can occur in filetype, preferences and project files and
4672 always has the format described here. Different menu items are loaded
4673 from different files, see the table in the `Build Menu Configuration`_
4674 section for details. All the settings can be configured from the dialogs
4675 except the execute command in filetype files and filetype definitions in
4676 the project file, so these are the only ones which need hand editing.
4678 The build-menu section stores one entry for each setting for each menu item that
4679 is configured. The keys for these settings have the format:
4685 * GG - is the menu item group,
4688 - NF for independent (non-filetype)
4691 * NN - is a two decimal digit number of the item within the group,
4693 * FF - is the field,
4697 - WD for working directory
4703 The project file contains project related settings and possibly a
4704 record of the current session files.
4707 [build-menu] additions
4708 ^^^^^^^^^^^^^^^^^^^^^^
4710 The project file also can have extra fields in the [build-menu] section
4711 in addition to those listed in `[build-menu] section`_ above.
4713 When filetype menu items are configured for the project they are stored
4714 in the project file.
4716 The ``filetypes`` entry is a list of the filetypes which exist in the
4719 For each filetype the entries for that filetype have the format defined in
4720 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4721 as it appears in the ``filetypes`` entry, eg the entry for the label of
4722 filetype menu item 0 for the C filetype would be
4730 Geany supports the following templates:
4734 * Function description
4739 To use these templates, just open the Edit menu or open the popup menu
4740 by right-clicking in the editor widget, and choose "Insert Comments"
4741 and insert templates as you want.
4743 Some templates (like File header or ChangeLog entry) will always be
4744 inserted at the top of the file.
4746 To insert a function description, the cursor must be inside
4747 of the function, so that the function name can be determined
4748 automatically. The description will be positioned correctly one line
4749 above the function, just check it out. If the cursor is not inside
4750 of a function or the function name cannot be determined, the inserted
4751 function description won't contain the correct function name but "unknown"
4755 Geany automatically reloads template information when it notices you
4756 save a file in the user's template configuration directory. You can
4757 also force this by selecting *Tools->Reload Configuration*.
4763 Meta data can be used with all templates, but by default user set
4764 meta data is only used for the ChangeLog and File header templates.
4766 In the configuration dialog you can find a tab "Templates" (see
4767 `Template preferences`_). You can define the default values
4768 which will be inserted in the templates.
4774 File templates are templates used as the basis of a new file. To
4775 use them, choose the *New (with Template)* menu item from the *File*
4778 By default, file templates are installed for some filetypes. Custom
4779 file templates can be added by creating the appropriate template file. You can
4780 also edit the default file templates.
4782 The file's contents are just the text to place in the document, with
4783 optional template wildcards like ``{fileheader}``. The fileheader
4784 wildcard can be placed anywhere, but it's usually put on the first
4785 line of the file, followed by a blank line.
4787 Adding file templates
4788 `````````````````````
4790 File templates are read from ``templates/files`` under the
4791 `Configuration file paths`_.
4793 The filetype to use is detected from the template file's extension, if
4794 any. For example, creating a file ``module.c`` would add a menu item
4795 which created a new document with the filetype set to 'C'.
4797 The template file is read from disk when the corresponding menu item is
4801 Customizing templates
4802 ^^^^^^^^^^^^^^^^^^^^^
4804 Each template can be customized to your needs. The templates are
4805 stored in the ``~/.config/geany/templates/`` directory (see the section called
4806 `Command line options`_ for further information about the configuration
4807 directory). Just open the desired template with an editor (ideally,
4808 Geany ;-) ) and edit the template to your needs. There are some
4809 wildcards which will be automatically replaced by Geany at startup.
4815 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4817 **Wildcards for character escaping**
4819 ============== ============================================= =======================================
4820 Wildcard Description Available in
4821 ============== ============================================= =======================================
4822 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4823 wildcards being expanded).
4824 cb } Closing Brace. file templates, file header, snippets.
4825 pc \% Percent (used to escape e.g. %block% in
4826 snippets). snippets.
4827 ============== ============================================= =======================================
4829 **Global wildcards**
4831 These are configurable, see `Template preferences`_.
4833 ============== ============================================= =======================================
4834 Wildcard Description Available in
4835 ============== ============================================= =======================================
4836 developer The name of the developer. file templates, file header,
4837 function description, ChangeLog entry,
4840 initial The developer's initials, e.g. "ET" for file templates, file header,
4841 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4844 mail The email address of the developer. file templates, file header,
4845 function description, ChangeLog entry,
4848 company The company the developer is working for. file templates, file header,
4849 function description, ChangeLog entry,
4852 version The initial version of a new file. file templates, file header,
4853 function description, ChangeLog entry,
4855 ============== ============================================= =======================================
4857 **Date & time wildcards**
4859 The format for these wildcards can be changed in the preferences
4860 dialog, see `Template preferences`_. You can use any conversion
4861 specifiers which can be used with the ANSI C strftime function.
4862 For details please see http://man.cx/strftime.
4864 ============== ============================================= =======================================
4865 Wildcard Description Available in
4866 ============== ============================================= =======================================
4867 year The current year. Default format is: YYYY. file templates, file header,
4868 function description, ChangeLog entry,
4871 date The current date. Default format: file templates, file header,
4872 YYYY-MM-DD. function description, ChangeLog entry,
4875 datetime The current date and time. Default format: file templates, file header,
4876 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4878 ============== ============================================= =======================================
4880 **Dynamic wildcards**
4882 ============== ============================================= =======================================
4883 Wildcard Description Available in
4884 ============== ============================================= =======================================
4885 untitled The string "untitled" (this will be file templates, file header,
4886 translated to your locale), used in function description, ChangeLog entry,
4887 file templates. bsd, gpl, snippets.
4889 geanyversion The actual Geany version, e.g. file templates, file header,
4890 "Geany |(version)|". function description, ChangeLog entry,
4893 filename The filename of the current file. file header, snippets, file
4894 For new files, it's only replaced when templates.
4895 first saving if found on the first 4 lines
4898 project The current project's name, if any. file header, snippets, file templates.
4900 description The current project's description, if any. file header, snippets, file templates.
4902 functionname The function name of the function at the function description.
4903 cursor position. This wildcard will only be
4904 replaced in the function description
4907 command:path Executes the specified command and replace file templates, file header,
4908 the wildcard with the command's standard function description, ChangeLog entry,
4909 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4911 ============== ============================================= =======================================
4913 **Template insertion wildcards**
4915 ============== ============================================= =======================================
4916 Wildcard Description Available in
4917 ============== ============================================= =======================================
4918 gpl This wildcard inserts a short GPL notice. file header.
4920 bsd This wildcard inserts a BSD licence notice. file header.
4922 fileheader The file header template. This wildcard snippets, file templates.
4923 will only be replaced in file templates.
4924 ============== ============================================= =======================================
4927 Special {command:} wildcard
4928 ***************************
4930 The {command:} wildcard is a special one because it can execute
4931 a specified command and put the command's output (stdout) into
4940 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4942 Using this wildcard you can insert nearly any arbitrary text into the
4945 In the environment of the executed command the variables
4946 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
4947 The value of these variables is filled in only if Geany knows about it.
4948 For example, ``GEANY_FUNCNAME`` is only filled within the function
4949 description template. However, these variables are ``always`` set,
4950 just maybe with an empty value.
4951 You can easily access them e.g. within an executed shell script using::
4957 If the specified command could not be found or not executed, the wildcard is substituted
4958 by an empty string. In such cases, you can find the occurred error message on Geany's
4959 standard error and in the Help->Debug Messages dialog.
4962 Customizing the toolbar
4963 -----------------------
4965 You can add, remove and reorder the elements in the toolbar by using
4966 the toolbar editor, or by manually editing the configuration file
4969 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
4970 by right-clicking on the toolbar itself and choosing it from the menu.
4972 Manually editing the toolbar layout
4973 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4975 To override the system-wide configuration file, copy it to your user
4976 configuration directory (see `Configuration file paths`_).
4980 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
4982 Then edit it and add any of the available elements listed in the file or remove
4983 any of the existing elements. Of course, you can also reorder the elements as
4984 you wish and add or remove additional separators.
4985 This file must be valid XML, otherwise the global toolbar UI definition
4986 will be used instead.
4988 Your changes are applied once you save the file.
4991 (1) You cannot add new actions which are not listed below.
4992 (2) Everything you add or change must be inside the /ui/toolbar/ path.
4995 Available toolbar elements
4996 ^^^^^^^^^^^^^^^^^^^^^^^^^^
4998 ================== ==============================================================================
4999 Element name Description
5000 ================== ==============================================================================
5001 New Create a new file
5002 Open Open an existing file
5003 Save Save the current file
5004 SaveAll Save all open files
5005 Reload Reload the current file from disk
5006 Close Close the current file
5007 CloseAll Close all open files
5008 Print Print the current file
5009 Cut Cut the current selection
5010 Copy Copy the current selection
5011 Paste Paste the contents of the clipboard
5012 Delete Delete the current selection
5013 Undo Undo the last modification
5014 Redo Redo the last modification
5015 NavBack Navigate back a location
5016 NavFor Navigate forward a location
5017 Compile Compile the current file
5018 Build Build the current file, includes a submenu for Make commands. Geany
5019 remembers the last chosen action from the submenu and uses this as default
5020 action when the button itself is clicked.
5021 Run Run or view the current file
5022 Color Open a color chooser dialog, to interactively pick colors from a palette
5023 ZoomIn Zoom in the text
5024 ZoomOut Zoom out the text
5025 UnIndent Decrease indentation
5026 Indent Increase indentation
5027 Replace Replace text in the current document
5028 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5029 Search Find the entered text in the current file (only useful if you also
5031 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5032 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5033 Preferences Show the preferences dialog
5035 ================== ==============================================================================
5039 Plugin documentation
5040 ====================
5045 The HTML Characters plugin helps when working with special
5046 characters in XML/HTML, e.g. German Umlauts ü and ä.
5049 Insert entity dialog
5050 ^^^^^^^^^^^^^^^^^^^^
5052 When the plugin is enabled, you can insert special character
5053 entities using *Tools->Insert Special HTML Characters*.
5055 This opens up a dialog where you can find a huge amount of special
5056 characters sorted by category that you might like to use inside your
5057 document. You can expand and collapse the categories by clicking on
5058 the little arrow on the left hand side. Once you have found the
5059 desired character click on it and choose "Insert". This will insert
5060 the entity for the character at the current cursor position. You
5061 might also like to double click the chosen entity instead.
5064 Replace special chars by its entity
5065 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5067 To help make a XML/HTML document valid the plugin supports
5068 replacement of special chars known by the plugin. Both bulk
5069 replacement and immediate replacement during typing are supported.
5071 A few characters will not be replaced. These are
5082 You can activate/deactivate this feature using the *Tools->HTML
5083 Replacement->Auto-replace Special Characters* menu item. If it's
5084 activated, all special characters (beside the given exceptions from
5085 above) known by the plugin will be replaced by their entities.
5087 You could also set a keybinding for the plugin to toggle the status
5094 After inserting a huge amount of text, e.g. by using copy & paste, the
5095 plugin allows bulk replacement of all known characters (beside the
5096 mentioned exceptions). You can find the function under the same
5097 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5098 configure a keybinding for the plugin.
5107 This plugin provides an option to automatically save documents.
5108 You can choose to save the current document, or all of your documents, at
5115 You can save the current document when the editor's focus goes out.
5116 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5117 will make the current document to be saved.
5122 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5123 a randomly chosen filename and set its filetype appropriate to the used template
5124 or when no template was used, to a configurable default filetype.
5125 This enables you to quickly compile, build and/or run the new file without the
5126 need to give it an explicit filename using the Save As dialog. This might be
5127 useful when you often create new files just for testing some code or something
5134 This plugin creates a backup copy of the current file in Geany when it is
5135 saved. You can specify the directory where the backup copy is saved and
5136 you can configure the automatically added extension in the configure dialog
5137 in Geany's plugin manager.
5139 After the plugin was loaded in Geany's plugin manager, every file is
5140 copied into the configured backup directory *after* the file has been saved
5143 The created backup copy file permissions are set to read-write only for
5144 the user. This should help to not create world-readable files on possibly
5145 unsecure destination directories like /tmp (especially useful
5146 on multi-user systems).
5147 This applies only to non-Windows systems. On Windows, no explicit file
5148 permissions are set.
5151 Additionally, you can define how many levels of the original file's
5152 directory structure should be replicated in the backup copy path.
5153 For example, setting the option
5154 *Directory levels to include in the backup destination* to *2*
5155 cause the plugin to create the last two components of the original
5156 file's path in the backup copy path and place the new file there.
5159 Contributing to this document
5160 =============================
5162 This document (``geany.txt``) is written in `reStructuredText`__
5163 (or "reST"). The source file for it is located in Geany's ``doc``
5164 subdirectory. If you intend on making changes, you should grab the
5165 source right from Git to make sure you've got the newest version.
5166 First, you need to configure the build system to generate the HTML
5167 documentation passing the *--enable-html-docs* option to the *configure*
5168 script. Then after editing the file, run ``make`` (from the root build
5169 directory or from the *doc* subdirectory) to build the HTML documentation
5170 and see how your changes look. This regenerates the ``geany.html`` file
5171 inside the *doc* subdirectory. To generate a PDF file, configure with
5172 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5173 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5176 __ http://docutils.sourceforge.net/rst.html
5178 After you are happy with your changes, create a patch e.g. by using::
5180 % git diff geany.txt > foo.patch
5182 or even better, by creating a Git-formatted patch which will keep authoring
5183 and description data, by first committing your changes (doing so in a fresh
5184 new branch is recommended for `master` not to diverge from upstream) and then
5185 using git format-patch::
5187 % git checkout -b my-documentation-changes # create a fresh branch
5188 % git commit geany.txt
5189 Write a good commit message...
5190 % git format-patch HEAD^
5191 % git checkout master # go back to master
5193 and then submit that file to the mailing list for review.
5195 Also you can clone the Geany repository at GitHub and send a pull request.
5197 Note, you will need the Python docutils software package installed
5198 to build the docs. The package is named ``python-docutils`` on Debian
5204 Scintilla keyboard commands
5205 ===========================
5207 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5209 This appendix is distributed under the terms of the License for
5210 Scintilla and SciTE. A copy of this license can be found in the file
5211 ``scintilla/License.txt`` included with the source code of this
5212 program and in the appendix of this document. See `License for
5213 Scintilla and SciTE`_.
5222 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5223 conventions. All move keys (arrows, page up/down, home and end)
5224 allows to extend or reduce the stream selection when holding the
5225 Shift key, and the rectangular selection when holding the
5226 appropriate keys (see `Column mode editing (rectangular selections)`_).
5228 Some keys may not be available with some national keyboards
5229 or because they are taken by the system such as by a window manager
5230 or GTK. Keyboard equivalents of menu commands are listed in the
5231 menus. Some less common commands with no menu equivalent are:
5233 ============================================= ======================
5235 ============================================= ======================
5236 Magnify text size. Ctrl-Keypad+
5237 Reduce text size. Ctrl-Keypad-
5238 Restore text size to normal. Ctrl-Keypad/
5240 Dedent block. Shift-Tab
5241 Delete to start of word. Ctrl-BackSpace
5242 Delete to end of word. Ctrl-Delete
5243 Delete to start of line. Ctrl-Shift-BackSpace
5244 Go to start of document. Ctrl-Home
5245 Extend selection to start of document. Ctrl-Shift-Home
5246 Go to start of display line. Alt-Home
5247 Extend selection to start of display line. Alt-Shift-Home
5248 Go to end of document. Ctrl-End
5249 Extend selection to end of document. Ctrl-Shift-End
5250 Extend selection to end of display line. Alt-Shift-End
5251 Previous paragraph. Shift extends selection. Ctrl-Up
5252 Next paragraph. Shift extends selection. Ctrl-Down
5253 Previous word. Shift extends selection. Ctrl-Left
5254 Next word. Shift extends selection. Ctrl-Right
5255 ============================================= ======================
5266 * Double-click on empty space in the notebook tab bar to open a
5268 * Middle-click on a document's notebook tab to close the document.
5269 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5271 * Double-click on a document's notebook tab to toggle all additional
5272 widgets (to show them again use the View menu or the keyboard
5273 shortcut). The interface pref must be enabled for this to work.
5278 * Alt-scroll wheel moves up/down a page.
5279 * Ctrl-scroll wheel zooms in/out.
5280 * Shift-scroll wheel scrolls 8 characters right/left.
5281 * Ctrl-click on a word in a document to perform *Go to Symbol Definition*.
5282 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5287 * Double-click on a symbol-list group to expand or compact it.
5292 * Scrolling the mouse wheel over a notebook tab bar will switch
5295 The following are derived from X-Windows features (but GTK still supports
5298 * Middle-click pastes the last selected text.
5299 * Middle-click on a scrollbar moves the scrollbar to that
5300 position without having to drag it.
5304 Compile-time options
5305 ====================
5307 There are some options which can only be changed at compile time,
5308 and some options which are used as the default for configurable
5309 options. To change these options, edit the appropriate source file
5310 in the ``src`` subdirectory. Look for a block of lines starting with
5311 ``#define GEANY_*``. Any definitions which are not listed here should
5315 Most users should not need to change these options.
5320 ============================== ============================================ ==================
5321 Option Description Default
5322 ============================== ============================================ ==================
5323 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5324 files. Be aware that the string can be
5325 translated, so change it only if you know
5327 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5328 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5329 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5331 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5333 **Windows specific**
5334 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5335 Windows file open and save dialogs instead
5336 GTK's file open and save dialogs. The
5337 default Windows file dialogs are missing
5338 some nice features like choosing a filetype
5339 or an encoding. *Do not touch this setting
5340 when building on a non-Win32 system.*
5341 ============================== ============================================ ==================
5346 ============================== ============================================ ==================
5347 Option Description Default
5348 ============================== ============================================ ==================
5349 GEANY_PROJECT_EXT The default filename extension for Geany geany
5350 project files. It is used when creating new
5351 projects and as filter mask for the project
5353 ============================== ============================================ ==================
5358 ============================== ============================================ ==================
5359 Option Description Default
5360 ============================== ============================================ ==================
5361 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5362 filetype with the extract filetype regex.
5363 ============================== ============================================ ==================
5368 ============================== ============================================ ==================
5369 Option Description Default
5370 ============================== ============================================ ==================
5371 GEANY_WORDCHARS These characters define word boundaries when a string with:
5372 making selections and searching using word a-z, A-Z, 0-9 and
5373 matching options. underscore.
5374 ============================== ============================================ ==================
5379 These are default settings that can be overridden in the `Preferences`_ dialog.
5381 ============================== ============================================ ==================
5382 Option Description Default
5383 ============================== ============================================ ==================
5384 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5385 trigger the autocompletion list.
5386 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5388 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5389 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5390 `Terminal emulators`_.
5391 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5392 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5393 and process plain text files. This can also
5395 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5396 GNU grep. This can also include a path.
5397 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5398 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5400 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5401 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5402 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5404 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5406 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5408 ============================== ============================================ ==================
5410 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5412 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5416 and on any non-Windows system is::
5418 xterm -e "/bin/sh %c"
5424 ============================== ============================================ ==================
5425 Option Description Default
5426 ============================== ============================================ ==================
5427 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5428 be shown in the editor window.
5429 This affects the special coloring
5430 when Geany detects a compiler output line as
5431 an error message and then highlights the
5432 corresponding line in the source code.
5433 Usually only the first few messages are
5434 interesting because following errors are
5436 All errors in the Compiler window are parsed
5437 and unaffected by this value.
5438 PRINTBUILDCMDS Every time a build menu item priority FALSE
5439 calculation is run, print the state of the
5440 menu item table in the form of the table
5441 in `Build Menu Configuration`_. May be
5442 useful to debug configuration file
5443 overloading. Warning produces a lot of
5444 output. Can also be enabled/disabled by the
5445 debugger by setting printbuildcmds to 1/0
5446 overriding the compile setting.
5447 ============================== ============================================ ==================
5451 GNU General Public License
5452 ==========================
5456 GNU GENERAL PUBLIC LICENSE
5457 Version 2, June 1991
5459 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5460 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5461 Everyone is permitted to copy and distribute verbatim copies
5462 of this license document, but changing it is not allowed.
5466 The licenses for most software are designed to take away your
5467 freedom to share and change it. By contrast, the GNU General Public
5468 License is intended to guarantee your freedom to share and change free
5469 software--to make sure the software is free for all its users. This
5470 General Public License applies to most of the Free Software
5471 Foundation's software and to any other program whose authors commit to
5472 using it. (Some other Free Software Foundation software is covered by
5473 the GNU Library General Public License instead.) You can apply it to
5476 When we speak of free software, we are referring to freedom, not
5477 price. Our General Public Licenses are designed to make sure that you
5478 have the freedom to distribute copies of free software (and charge for
5479 this service if you wish), that you receive source code or can get it
5480 if you want it, that you can change the software or use pieces of it
5481 in new free programs; and that you know you can do these things.
5483 To protect your rights, we need to make restrictions that forbid
5484 anyone to deny you these rights or to ask you to surrender the rights.
5485 These restrictions translate to certain responsibilities for you if you
5486 distribute copies of the software, or if you modify it.
5488 For example, if you distribute copies of such a program, whether
5489 gratis or for a fee, you must give the recipients all the rights that
5490 you have. You must make sure that they, too, receive or can get the
5491 source code. And you must show them these terms so they know their
5494 We protect your rights with two steps: (1) copyright the software, and
5495 (2) offer you this license which gives you legal permission to copy,
5496 distribute and/or modify the software.
5498 Also, for each author's protection and ours, we want to make certain
5499 that everyone understands that there is no warranty for this free
5500 software. If the software is modified by someone else and passed on, we
5501 want its recipients to know that what they have is not the original, so
5502 that any problems introduced by others will not reflect on the original
5503 authors' reputations.
5505 Finally, any free program is threatened constantly by software
5506 patents. We wish to avoid the danger that redistributors of a free
5507 program will individually obtain patent licenses, in effect making the
5508 program proprietary. To prevent this, we have made it clear that any
5509 patent must be licensed for everyone's free use or not licensed at all.
5511 The precise terms and conditions for copying, distribution and
5512 modification follow.
5514 GNU GENERAL PUBLIC LICENSE
5515 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5517 0. This License applies to any program or other work which contains
5518 a notice placed by the copyright holder saying it may be distributed
5519 under the terms of this General Public License. The "Program", below,
5520 refers to any such program or work, and a "work based on the Program"
5521 means either the Program or any derivative work under copyright law:
5522 that is to say, a work containing the Program or a portion of it,
5523 either verbatim or with modifications and/or translated into another
5524 language. (Hereinafter, translation is included without limitation in
5525 the term "modification".) Each licensee is addressed as "you".
5527 Activities other than copying, distribution and modification are not
5528 covered by this License; they are outside its scope. The act of
5529 running the Program is not restricted, and the output from the Program
5530 is covered only if its contents constitute a work based on the
5531 Program (independent of having been made by running the Program).
5532 Whether that is true depends on what the Program does.
5534 1. You may copy and distribute verbatim copies of the Program's
5535 source code as you receive it, in any medium, provided that you
5536 conspicuously and appropriately publish on each copy an appropriate
5537 copyright notice and disclaimer of warranty; keep intact all the
5538 notices that refer to this License and to the absence of any warranty;
5539 and give any other recipients of the Program a copy of this License
5540 along with the Program.
5542 You may charge a fee for the physical act of transferring a copy, and
5543 you may at your option offer warranty protection in exchange for a fee.
5545 2. You may modify your copy or copies of the Program or any portion
5546 of it, thus forming a work based on the Program, and copy and
5547 distribute such modifications or work under the terms of Section 1
5548 above, provided that you also meet all of these conditions:
5550 a) You must cause the modified files to carry prominent notices
5551 stating that you changed the files and the date of any change.
5553 b) You must cause any work that you distribute or publish, that in
5554 whole or in part contains or is derived from the Program or any
5555 part thereof, to be licensed as a whole at no charge to all third
5556 parties under the terms of this License.
5558 c) If the modified program normally reads commands interactively
5559 when run, you must cause it, when started running for such
5560 interactive use in the most ordinary way, to print or display an
5561 announcement including an appropriate copyright notice and a
5562 notice that there is no warranty (or else, saying that you provide
5563 a warranty) and that users may redistribute the program under
5564 these conditions, and telling the user how to view a copy of this
5565 License. (Exception: if the Program itself is interactive but
5566 does not normally print such an announcement, your work based on
5567 the Program is not required to print an announcement.)
5569 These requirements apply to the modified work as a whole. If
5570 identifiable sections of that work are not derived from the Program,
5571 and can be reasonably considered independent and separate works in
5572 themselves, then this License, and its terms, do not apply to those
5573 sections when you distribute them as separate works. But when you
5574 distribute the same sections as part of a whole which is a work based
5575 on the Program, the distribution of the whole must be on the terms of
5576 this License, whose permissions for other licensees extend to the
5577 entire whole, and thus to each and every part regardless of who wrote it.
5579 Thus, it is not the intent of this section to claim rights or contest
5580 your rights to work written entirely by you; rather, the intent is to
5581 exercise the right to control the distribution of derivative or
5582 collective works based on the Program.
5584 In addition, mere aggregation of another work not based on the Program
5585 with the Program (or with a work based on the Program) on a volume of
5586 a storage or distribution medium does not bring the other work under
5587 the scope of this License.
5589 3. You may copy and distribute the Program (or a work based on it,
5590 under Section 2) in object code or executable form under the terms of
5591 Sections 1 and 2 above provided that you also do one of the following:
5593 a) Accompany it with the complete corresponding machine-readable
5594 source code, which must be distributed under the terms of Sections
5595 1 and 2 above on a medium customarily used for software interchange; or,
5597 b) Accompany it with a written offer, valid for at least three
5598 years, to give any third party, for a charge no more than your
5599 cost of physically performing source distribution, a complete
5600 machine-readable copy of the corresponding source code, to be
5601 distributed under the terms of Sections 1 and 2 above on a medium
5602 customarily used for software interchange; or,
5604 c) Accompany it with the information you received as to the offer
5605 to distribute corresponding source code. (This alternative is
5606 allowed only for noncommercial distribution and only if you
5607 received the program in object code or executable form with such
5608 an offer, in accord with Subsection b above.)
5610 The source code for a work means the preferred form of the work for
5611 making modifications to it. For an executable work, complete source
5612 code means all the source code for all modules it contains, plus any
5613 associated interface definition files, plus the scripts used to
5614 control compilation and installation of the executable. However, as a
5615 special exception, the source code distributed need not include
5616 anything that is normally distributed (in either source or binary
5617 form) with the major components (compiler, kernel, and so on) of the
5618 operating system on which the executable runs, unless that component
5619 itself accompanies the executable.
5621 If distribution of executable or object code is made by offering
5622 access to copy from a designated place, then offering equivalent
5623 access to copy the source code from the same place counts as
5624 distribution of the source code, even though third parties are not
5625 compelled to copy the source along with the object code.
5627 4. You may not copy, modify, sublicense, or distribute the Program
5628 except as expressly provided under this License. Any attempt
5629 otherwise to copy, modify, sublicense or distribute the Program is
5630 void, and will automatically terminate your rights under this License.
5631 However, parties who have received copies, or rights, from you under
5632 this License will not have their licenses terminated so long as such
5633 parties remain in full compliance.
5635 5. You are not required to accept this License, since you have not
5636 signed it. However, nothing else grants you permission to modify or
5637 distribute the Program or its derivative works. These actions are
5638 prohibited by law if you do not accept this License. Therefore, by
5639 modifying or distributing the Program (or any work based on the
5640 Program), you indicate your acceptance of this License to do so, and
5641 all its terms and conditions for copying, distributing or modifying
5642 the Program or works based on it.
5644 6. Each time you redistribute the Program (or any work based on the
5645 Program), the recipient automatically receives a license from the
5646 original licensor to copy, distribute or modify the Program subject to
5647 these terms and conditions. You may not impose any further
5648 restrictions on the recipients' exercise of the rights granted herein.
5649 You are not responsible for enforcing compliance by third parties to
5652 7. If, as a consequence of a court judgment or allegation of patent
5653 infringement or for any other reason (not limited to patent issues),
5654 conditions are imposed on you (whether by court order, agreement or
5655 otherwise) that contradict the conditions of this License, they do not
5656 excuse you from the conditions of this License. If you cannot
5657 distribute so as to satisfy simultaneously your obligations under this
5658 License and any other pertinent obligations, then as a consequence you
5659 may not distribute the Program at all. For example, if a patent
5660 license would not permit royalty-free redistribution of the Program by
5661 all those who receive copies directly or indirectly through you, then
5662 the only way you could satisfy both it and this License would be to
5663 refrain entirely from distribution of the Program.
5665 If any portion of this section is held invalid or unenforceable under
5666 any particular circumstance, the balance of the section is intended to
5667 apply and the section as a whole is intended to apply in other
5670 It is not the purpose of this section to induce you to infringe any
5671 patents or other property right claims or to contest validity of any
5672 such claims; this section has the sole purpose of protecting the
5673 integrity of the free software distribution system, which is
5674 implemented by public license practices. Many people have made
5675 generous contributions to the wide range of software distributed
5676 through that system in reliance on consistent application of that
5677 system; it is up to the author/donor to decide if he or she is willing
5678 to distribute software through any other system and a licensee cannot
5681 This section is intended to make thoroughly clear what is believed to
5682 be a consequence of the rest of this License.
5684 8. If the distribution and/or use of the Program is restricted in
5685 certain countries either by patents or by copyrighted interfaces, the
5686 original copyright holder who places the Program under this License
5687 may add an explicit geographical distribution limitation excluding
5688 those countries, so that distribution is permitted only in or among
5689 countries not thus excluded. In such case, this License incorporates
5690 the limitation as if written in the body of this License.
5692 9. The Free Software Foundation may publish revised and/or new versions
5693 of the General Public License from time to time. Such new versions will
5694 be similar in spirit to the present version, but may differ in detail to
5695 address new problems or concerns.
5697 Each version is given a distinguishing version number. If the Program
5698 specifies a version number of this License which applies to it and "any
5699 later version", you have the option of following the terms and conditions
5700 either of that version or of any later version published by the Free
5701 Software Foundation. If the Program does not specify a version number of
5702 this License, you may choose any version ever published by the Free Software
5705 10. If you wish to incorporate parts of the Program into other free
5706 programs whose distribution conditions are different, write to the author
5707 to ask for permission. For software which is copyrighted by the Free
5708 Software Foundation, write to the Free Software Foundation; we sometimes
5709 make exceptions for this. Our decision will be guided by the two goals
5710 of preserving the free status of all derivatives of our free software and
5711 of promoting the sharing and reuse of software generally.
5715 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5716 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5717 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5718 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5719 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5720 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5721 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5722 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5723 REPAIR OR CORRECTION.
5725 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5726 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5727 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5728 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5729 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5730 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5731 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5732 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5733 POSSIBILITY OF SUCH DAMAGES.
5735 END OF TERMS AND CONDITIONS
5737 How to Apply These Terms to Your New Programs
5739 If you develop a new program, and you want it to be of the greatest
5740 possible use to the public, the best way to achieve this is to make it
5741 free software which everyone can redistribute and change under these terms.
5743 To do so, attach the following notices to the program. It is safest
5744 to attach them to the start of each source file to most effectively
5745 convey the exclusion of warranty; and each file should have at least
5746 the "copyright" line and a pointer to where the full notice is found.
5748 <one line to give the program's name and a brief idea of what it does.>
5749 Copyright (C) <year> <name of author>
5751 This program is free software; you can redistribute it and/or modify
5752 it under the terms of the GNU General Public License as published by
5753 the Free Software Foundation; either version 2 of the License, or
5754 (at your option) any later version.
5756 This program is distributed in the hope that it will be useful,
5757 but WITHOUT ANY WARRANTY; without even the implied warranty of
5758 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5759 GNU General Public License for more details.
5761 You should have received a copy of the GNU General Public License along
5762 with this program; if not, write to the Free Software Foundation, Inc.,
5763 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5766 Also add information on how to contact you by electronic and paper mail.
5768 If the program is interactive, make it output a short notice like this
5769 when it starts in an interactive mode:
5771 Gnomovision version 69, Copyright (C) year name of author
5772 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5773 This is free software, and you are welcome to redistribute it
5774 under certain conditions; type `show c' for details.
5776 The hypothetical commands `show w' and `show c' should show the appropriate
5777 parts of the General Public License. Of course, the commands you use may
5778 be called something other than `show w' and `show c'; they could even be
5779 mouse-clicks or menu items--whatever suits your program.
5781 You should also get your employer (if you work as a programmer) or your
5782 school, if any, to sign a "copyright disclaimer" for the program, if
5783 necessary. Here is a sample; alter the names:
5785 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5786 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5788 <signature of Ty Coon>, 1 April 1989
5789 Ty Coon, President of Vice
5791 This General Public License does not permit incorporating your program into
5792 proprietary programs. If your program is a subroutine library, you may
5793 consider it more useful to permit linking proprietary applications with the
5794 library. If this is what you want to do, use the GNU Library General
5795 Public License instead of this License.
5800 License for Scintilla and SciTE
5801 ===============================
5803 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5807 Permission to use, copy, modify, and distribute this software and
5808 its documentation for any purpose and without fee is hereby granted,
5809 provided that the above copyright notice appear in all copies and
5810 that both that copyright notice and this permission notice appear in
5811 supporting documentation.
5813 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5814 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5815 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5816 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5817 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5818 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5819 USE OR PERFORMANCE OF THIS SOFTWARE.