Geany

A fast, light, GTK+ IDE

Authors:Enrico Tröger Nick Treleaven Frank Lanitz

Date: 2010-08-11

Version: 0.19.1

Copyright © 2005-2010

This document is distributed under the terms of the GNU General Public License as published by the FreeSoftware Foundation; either version 2 of the License, or (at your option) any later version. A copy of thislicense can be found in the file COPYING included with the source code of this program, and also in thechapter GNU General Public License.

Contents

IntroductionAbout GeanyWhere to get itLicenseAbout this document

InstallationRequirementsBinary packagesSource compilation

Autotools based build systemWaf based build system

Waf CacheCleaning the Cache

Custom installationDynamic linking loader support and VTEBuild problems

Installation prefixUsage

Getting startedThe Geany workspaceCommand line optionsGeneral

StartupOpening files from the command-line in a running instanceVirtual terminal emulator widget (VTE)Defining own widget styles using .gtkrc-2.0

DocumentsSwitching between documents

Character sets and Unicode Byte-Order-Mark (BOM)Using character setsIn-file encoding specificationSpecial encoding "None"Unicode Byte-Order-Mark (BOM)

EditingFoldingColumn mode editing (rectangular selections)Drag and drop of textIndentationAuto-indentationBookmarksCode navigation historySending text through custom commandsContext actionsAutocompletion

Word part completionScope autocompletion

User-definable snippetsInserting Unicode characters

Search, replace and go toToolbar entries

Search barFind

Matching optionsFind allChange font in search dialog text fields

Find usageFind in files

Filtering out version control files

ReplaceReplace all

Go to tag definitionGo to tag declarationGo to lineRegular expressions

TagsWorkspace tagsGlobal tags

Default global tags filesGlobal tags file formatGenerating a global tags file

Ignore tagsPreferences

General Startup preferencesStartupShutdownPaths

General Miscellaneous preferencesMiscellaneousSearchProjects

Interface preferencesSidebarFontsEditor tabsTab positionsMiscellaneous

Toolbar preferencesToolbarAppearance

Editor Features preferencesFeatures

Editor Indentation preferencesIndentation group

Editor Completions preferencesCompletionsAuto-close quotes and brackets

Editor Display preferencesDisplayLong line markerVirtual spaces

Files preferencesNew filesSaving filesMiscellaneous

Tools preferencesTool pathsCommands

Template preferencesTemplate data

Keybinding preferencesPrinting preferencesTerminal (VTE) preferences

Terminal widgetProject Management

New ProjectProject Properties

Set Base Path ButtonOpen ProjectClose Project

Build MenuIndicatorsDefault Build Menu Items

CompileBuildMakeMake custom targetMake objectNext ErrorPrevious ErrorExecuteStopping running processes

Terminal emulatorsSet Build Commands

Build Menu ConfigurationBuild Menu Commands Dialog

Substitutions in Commands and Working DirectoriesBuild Menu Keyboard Shortcuts

Configuration FilesPrinting supportPluginsKeybindings

Switching documentsConfigurable keybindings

File keybindingsEditor keybindingsClipboard keybindingsSelect keybindingsInsert keybindingsFormat keybindingsSettings keybindingsSearch keybindingsGo to keybindingsView keybindingsFocus keybindingsNotebook tab keybindingsDocument keybindingsBuild keybindingsTools keybindingsHelp keybindings

Configuration filesTools menu itemsGlobal configuration fileFiletype definition files

Custom filetypesSystem filesUser filesFormat

[styling] SectionUsing a named style

[keywords] Section[lexer_properties] Section[settings] Section[build_settings] Section

Special file filetypes.common[named_styles] Section[styling] Section[settings] Section

Filetype extensionsPreferences File Format

Hidden preferences[build-menu] Section

Project File Format[build-menu] Additions

TemplatesTemplate meta dataFile templates

Custom file templatesFiletype templates

Customizing templatesTemplate wildcards

Special {command:} wildcardCustomizing the toolbar

Manually editing of the toolbar layoutAvailable toolbar elements

Plugin documentationSave Actions

Instant SaveBackup Copy

Contributing to this documentScintilla keyboard commands

Keyboard commandsTips and tricks

Document notebookEditorInterfaceGTK-related

Compile-time optionssrc/geany.hproject.heditor.hkeyfile.cbuild.c

GNU General Public LicenseLicense for Scintilla and SciTE

Introduction

About Geany

Geany is a small and lightweight Integrated Development Environment. It was developed to provide a smalland fast IDE, which has only a few dependencies on other packages. Another goal was to be asindependent as possible from a particular Desktop Environment like KDE or GNOME - Geany only requiresthe GTK2 runtime libraries.

Some basic features of Geany:

Syntax highlightingCode foldingAutocompletion of symbols/wordsConstruct completion/snippetsAuto-closing of XML and HTML tagsCalltipsMany supported filetypes including C, Java, PHP, HTML, Python, Perl, Pascal, and othersSymbol listsCode navigationBuild system to compile and execute your codeSimple project managementPlugin interface

Where to get it

You can obtain Geany from http://www.geany.org/ or perhaps also from your distribution. For a list ofavailable packages, please see http://www.geany.org/Download/ThirdPartyPackages.

License

Geany is distributed under the terms of the GNU General Public License as published by the Free SoftwareFoundation; either version 2 of the License, or (at your option) any later version. A copy of this license canbe found in the file COPYING included with the source code of this program and in the chapter, GNUGeneral Public License.

The included Scintilla library (found in the subdirectory scintilla/) has its own license, which can befound in the chapter, License for Scintilla and SciTE.

About this document

This documentation is available in HTML and text formats. The latest version can always be found athttp://www.geany.org/.

If you want to contribute to it, see Contributing to this document.

Installation

Requirements

You will need the GTK (>= 2.8.0) libraries and their dependencies (Pango, GLib and ATK). Your distro shouldprovide packages for these, usually installed by default. For Windows, you can download an installer fromthe website which bundles these libraries.

Binary packages

There are many binary packages available. For an up-to-date but maybe incomplete list seehttp://www.geany.org/Download/ThirdPartyPackages.

Source compilation

Compiling Geany is quite easy. To do so, you need the GTK (>= 2.8.0) libraries and header files. You alsoneed the Pango, GLib and ATK libraries and header files. All these files are available at http://www.gtk.org,but very often your distro will provide development packages to save the trouble of building these yourself.

Furthermore you need, of course, a C and C++ compiler. The GNU versions of these tools arerecommended.

Autotools based build system

The Autotools based build system is very mature and has been well tested. To use it, you just need theMake tool, preferably GNU Make.

Then run the following commands:

$ ./configure

$ make

Then as root:

% make install

Waf based build system

The Waf build system is still quite young and under heavy development but already in a usable state. Incontrast to the Autotools system, Waf needs Python. So before using Waf, you need to install Python onyour system. The advantage of the Waf build system over the Autotools based build system is that thewhole build process might be a bit faster. Especially when you use the Waf cache feature for repetitivebuilds (e.g. when changing only a few source files to test something) will become much faster since Waf willcache and re-use the unchanged built files and only compile the changed code again. See Waf Cache fordetails. To build Geany with Waf as run:

$ ./waf configure$ ./waf build

Then as root:

% ./waf install

Waf Cache

The Waf build system has a nice and interesting feature which can help to avoid a lot of unnecessaryrebuilding of unchanged code. This often happens when developing new features or trying to debugsomething in Geany. Waf is able to store and retrieve the object files from a cache. This cache is declaredusing the environment variable WAFCACHE. A possible location of the cache directory could be~/.cache/waf. In order to make use of this, you first need to create this directory:

$ mkdir -p ~/.cache/waf

then add the environment variable to your shell configuration (the following example is for Bash and shouldbe adjusted to your used shell):

export WAFCACHE=/home/username/.cache/waf

Remember to replace username with your actual username.

More information about the Waf cache feature are available athttp://code.google.com/p/waf/wiki/CacheObjectFiles.

Cleaning the Cache

You should be careful about the size of the cache directory as it may grow rapidly over time. Waf doesn't doany cleaning or other house-keeping of the cache yet, so you need to keep it clean by yourself. An easyway to keep it clean is to run the following command regularly to remove old cached files:

$ find /home/username/.cache/waf -mtime +14 -exec rm {} \;

This will delete all files in the cache directory which are older than 14 days.

For details about the find command and its options, check its manual page.

Custom installation

The configure script supports several common options, for a detailed list, type:

$ ./configure --help

or::$ ./waf --help

(depending on which build system you use).

You may also want to read the INSTALL file for advanced installation options.

See also Compile-time options.

Dynamic linking loader support and VTE

In the case that your system lacks dynamic linking loader support, you probably want to pass the option --disable-vte to the configure script. This prevents compiling Geany with dynamic linking loader supportfor automatically loading libvte.so.4 if available.

Build problems

If there are any errors during compilation, check your build environment and try to find the error, otherwisecontact the mailing list or one the authors. Sometimes you might need to ask for specific help from yourdistribution.

Installation prefix

If you want to edit any of Geany's system configuration files after installation you will need to know theinstallation prefix. Usually this is not necessary as you can just use per user configuration files and you willnot need root permissions.

Use the --print-prefix option to Geany to check - see Command line options. The first path is theprefix.

This is commonly /usr if you installed from a binary package, or /usr/local if you build from source.

Usage

Getting started

You can start Geany in the following ways:

From the Desktop Environment menu:

Choose in your application menu of your used Desktop Environment: Development --> Geany.

From the command line:

To start Geany from a command line, type the following and press Return:

% geany

The Geany workspace

The Geany window is shown in the following figure:

The workspace has the following parts:

The menu.An optional toolbar.An optional sidebar that can show the following tabs:

Documents - A document list, andSymbols - A list of symbols in your code.

The main editor window.An optional message window which can show the following tabs:

Status - A list of status messages.Compiler - The output of compiling or building programs.Messages - Results of 'Find Usage', 'Find Usage' 'Find in Files' and other actionsScribble - A text scratchpad for any use.Terminal - An optional terminal window.

A status bar

Additional tabs may be added to the sidebar and message window by plugins.

The position of the tabs can be selected in the interface preferences.

The sizes of the sidebar and message window can be adjusted by dragging the dividers.

Command line options

Shortoption Long option Function

none +number Set initial line number for the first opened file (same as --line, do not put a space between the + sign and thenumber). E.g. "geany +7 foo.bar" will open the file foo.bar and place the cursor in line 7.

none --column Set initial column number for the first opened file.

-cdir_name

--config=directory_name

Use an alternate configuration directory. The default configuration directory is ~/.config/geany/ and that iswhere geany.conf and other configuration files reside.

none --ft-names Print a list of Geany's internal filetype names (useful for snippets configuration).

-g --generate-tags Generate a global tags file (see Generating a global tags file).

-P --no-preprocessing Don't preprocess C/C++ files when generating tags.

-i --new-instance Do not open files in a running instance, force opening a new instance. Only available if Geany was compiled withsupport for Sockets.

-l --line Set initial line number for the first opened file.

none --list-documents Return a list of open documents in a running Geany instance. This can be used to read the currently openeddocuments in Geany from an external script or tool. The returned list is separated by newlines (LF) and consistsof the full, UTF-8 encoded filenames of the documents. Only available if Geany was compiled with support forSockets.

-m --no-msgwin Do not show the message window. Use this option if you do not need compiler messages or VTE support.

-n --no-ctags Do not load symbol completion and call tip data. Use this option if you do not want to use them.

-p --no-plugins Do not load plugins or plugin support.

none --print-prefix Print installation prefix, the data directory, the lib directory and the locale directory (in this order) to stdout, oneline each. This is mainly intended for plugin authors to detect installation paths.

-s --no-session Do not load the previous session's files.

-t --no-terminal Do not load terminal support. Use this option if you do not want to load the virtual terminal emulator widget atstartup. If you do not have libvte.so.4 installed, then terminal-support is automatically disabled. Onlyavailable if Geany was compiled with support for VTE.

none --socket-fileUse this socket filename for communication with a running Geany instance. This can be used with the followingcommand to execute Geany on the current workspace:

geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')

none --vte-lib Specify explicitly the path including filename or only the filename to the VTE library, e.g. /usr/lib/libvte.soor libvte.so. This option is only needed when the auto-detection does not work. Only available if Geany wascompiled with support for VTE.

-v --verbose Be verbose (print useful status messages).

-V --version Show version information and exit.

-? --help Show help information and exit.

none [files ...]Open all given files at startup. This option causes Geany to ignore loading stored files from the last session (ifenabled). Geany also recognizes line and column information when appended to the filename with colons, e.g."geany foo.bar:10:5" will open the file foo.bar and place the cursor in line 10 at column 5.

Projects can also be opened but a project file (*.geany) must be the first non-option argument. All additionallygiven files are ignored.

You can also pass line number and column number information, e.g.:

geany some_file.foo:55:4

Geany supports all generic GTK options, a list is available on the help screen.

General

Startup

At startup, Geany loads all files from the last time Geany was launched. You can disable this feature in thepreferences dialog (see General Startup preferences). If you specify some files on the command line, onlythese files will be opened, but you can find the files from the last session in the file menu under the "Recentfiles" item. By default this contains the last 10 recently opened files. You can change the number ofrecently opened files in the preferences dialog.

You can start several instances of Geany, but only the first will load files from the last session. To run asecond instance of Geany, do not specify any filenames on the command-line, or disable opening files in arunning instance using the appropriate command line option.

Opening files from the command-line in a running instance

Geany detects if there is an an instance of itself already running and opens files from the command-line inthat instance. So, Geany can be used to view and edit files by opening them from other programs such asa file manager.

You can also pass line number and column number information, e.g.:

geany some_file.foo:55:4

This would open the file some_file.foo with the cursor on line 55, column 4.

If you do not like this for some reason, you can disable using the first instance by using the appropriatecommand line option -- see the section called Command line options.

Virtual terminal emulator widget (VTE)

If you have installed libvte.so on your system, it is loaded automatically by Geany, and you will have aterminal widget in the notebook at the bottom.

If Geany cannot find any libvte.so at startup, the terminal widget will not be loaded. So there is no needto install the package containing this file in order to run Geany. Additionally, you can disable the use of theterminal widget by command line option, for more information see the section called Command lineoptions.

You can use this terminal (from now on called VTE) much as you would a terminal program like xterm.There is basic clipboard support. You can paste the contents of the clipboard by pressing the right mousebutton to open the popup menu, and choosing Paste. To copy text from the VTE, just select the desiredtext and then press the right mouse button and choose Copy from the popup menu. On systems runningthe X Window System you can paste the last selected text by pressing the middle mouse button in the VTE(on 2-button mice, the middle button can often be simulated by pressing both mouse buttons together).

In the preferences dialog you can specify a shell which should be started in the VTE. To make the specifiedshell a login shell just use the appropriate command line options for the shell. These options should befound in the manual page of the shell. For zsh and bash you can use the argument --login.

Note

Geany tries to load libvte.so. If this fails, it tries to load some other filenames. If this fails too, you shouldcheck whether you installed libvte correctly. Again note, Geany will run without this library.

It could be, that the library is called something else than libvte.so (e.g. on FreeBSD 6.0 it is calledlibvte.so.8). If so please set a link to the correct file (as root):

# ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so

Obviously, you have to adjust the paths and set X to the number of your libvte.so.

You can also specify the filename of the VTE library to use on the command line (see the section calledCommand line options) or at compile time by specifying the command line option --with-vte-module-path to ./configure.

Defining own widget styles using .gtkrc-2.0

You can define your widget style for many of Geany's GUI parts. To do this, just edit your .gtkrc-2.0(usually found in your home directory on UNIX-like systems and in the etc subdirectory of your Geanyinstallation on Windows).

To have a defined style used by Geany you must assign it to at least one of Geany's widgets. For exampleuse the following line:

widget "Geany*" style "geanyStyle"

This would assign your style "geany_style" to all Geany widgets. You can also assign styles only to specificwidgets. At the moment you can use the following widgets:

GeanyMainWindowGeanyEditMenuGeanyToolbarMenuGeanyDialogGeanyDialogPrefsGeanyDialogProjectGeanyDialogSearch

GeanyMenubarGeanyToolbar

An example of a simple .gtkrc-2.0:

style "geanyStyle"{ font_name="Sans 12"}widget "GeanyMainWindow" style "geanyStyle"

style "geanyStyle"{ font_name="Sans 10"}widget "GeanyPrefsDialog" style "geanyStyle"

Documents

Switching between documents

The documents list and the editor tabs are two different ways to switch between documents using themouse. When you hit the key combination to move between tabs, the order is determined by the taborder. Its is not alphabetical as shown in the documents list (regardless of whether or not editor tabs arevisible).

The tabs can be positioned at the top, bottom, left, or right of the main editing window, by a selection inthe interface preferences.

See the Notebook tab keybindings section for useful shortcuts including for Most-Recently-Used documentswitching.

Character sets and Unicode Byte-Order-Mark (BOM)

Using character sets

Geany provides support for detecting and converting character sets. So you can open and save files indifferent character sets, and even convert a file from one character set to another. To do this, Geany usesthe character conversion capabilities of the GLib library.

Only text files are supported, i.e. opening files which contain NULL-bytes may fail. Geany will try to open thefile anyway but it is likely that the file will be truncated because it can only be read up to the firstoccurrence of a NULL-byte. All characters after this position are lost and are not written when you save thefile.

Geany tries to detect the encoding of a file while opening it, but auto-detecting the encoding of a file is noteasy and sometimes an encoding might not be detected correctly. In this case you have to set theencoding of the file manually in order to display it correctly. You can this in the file open dialog by selectingan encoding in the drop down box or by reloading the file with the file menu item "Reload as". The auto-detection works well for most encodings but there are also some encodings where it is known that auto-detection has problems.

There are different ways to set different encodings in Geany:

Using the file open dialog

This opens the file with the encoding specified in the encoding drop down box. If the encoding is setto "Detect from file" auto-detection will be used. If the encoding is set to "Without encoding (None)"the file will be opened without any character conversion and Geany will not try to auto-detect theencoding (see below for more information).

Using the "Reload as" menu item

This item reloads the current file with the specified encoding. It can help if you opened a file andfound out that the wrong encoding was used.

Using the "Set encoding" menu item

Contrary to the above two options, this will not change or reload the current file unless you save it. Itis useful when you want to change the encoding of the file.

Specifying the encoding in the file itself

As mentioned above, auto-detecting the encoding of a file may fail on some encodings. If you knowthat Geany doesn't open a certain file, you can add the specification line, described in the nextsection, to the beginning of the file to force Geany to use a specific encoding when opening the file.

In-file encoding specification

Geany detects meta tags of HTML files which contain charset information like:

<meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />

and the specified charset is used when opening the file. This is useful if the encoding of the file cannot bedetected properly. For non-HTML files you can also define a line like:

/* geany_encoding=ISO-8859-15 */

or:

# geany_encoding=ISO-8859-15 #

to force an encoding to be used. The #, /* and */ are examples of filetype-specific comment characters. Itdoesn't matter which characters are around the string " geany_encoding=ISO-8859-15 " as long as there isat least one whitespace character before and after this string. Whitespace characters are in this case aspace or tab character. An example to use this could be you have a file with ISO-8859-15 encoding butGeany constantly detects the file encoding as ISO-8859-1. Then you simply add such a line to the file andGeany will open it correctly the next time.

Since Geany 0.15 you can also use lines which match the regular expression used to find the encodingstring: coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*

Note

These specifications must be in the first 512 bytes of the file. Anything after the first 512 bytes will not berecognized.

Some examples are:

# encoding = ISO-8859-15

or:

# coding: ISO-8859-15

Special encoding "None"

There is a special encoding "None" which uses no encoding. It is useful when you know that Geany cannotauto-detect the encoding of a file and it is not displayed correctly. Especially when the file contains NULL-bytes this can be useful to skip auto detection and open the file properly at least until the occurrence ofthe first NULL-byte. Using this encoding opens the file as it is without any character conversion.

Unicode Byte-Order-Mark (BOM)

Furthermore, Geany detects a Unicode Byte Order Mark (see http://en.wikipedia.org/wiki/Byte_Order_Markfor details). Of course, this feature is only available if the opened file is in a Unicode encoding. The ByteOrder Mark helps to detect the encoding of a file, e.g. whether it is UTF-16LE or UTF-16BE and so on. OnUnix-like systems using a Byte Order Mark could cause some problems for programs not expecting it, e.g.the compiler gcc stops with stray errors, PHP does not parse a script containing a BOM and script filesstarting with a she-bang maybe cannot be started. In the status bar you can easily see whether the filestarts with a BOM or not.

If you want to set a BOM for a file or if you want to remove it from a file, just use the document menu andtoggle the checkbox.

Note

If you are unsure what a BOM is or if you do not understand where to use it, then it is probably notimportant for you and you can safely ignore it.

Editing

Folding

Geany provides basic code folding support. Folding means the ability to show and hide parts of the text inthe current file. You can hide unimportant code sections and concentrate on the parts you are working onand later you can show hidden sections again. In the editor window there is a small grey margin on the leftside with [+] and [-] symbols which show hidden parts and hide parts of the file respectively. By clicking onthese icons you can simply show and hide sections which are marked by vertical lines within this margin.For many filetypes nested folding is supported, so there may be several fold points within other fold points.

Note

You can customize the folding icon and line styles - see the filetypes.common Folding Settings.

If you don't like it or don't need it at all, you can simply disable folding support completely in thepreferences dialog.

The folding behaviour can be changed with the "Fold/Unfold all children of a fold point" option in thepreference dialog. If activated, Geany will unfold all nested fold points below the current one if they arealready folded (when clicking on a [+] symbol). When clicking on a [-] symbol, Geany will fold all nested foldpoints below the current one if they are unfolded.

This option can be inverted by pressing the Shift key while clicking on a fold symbol. That means, if the"Fold/Unfold all children of a fold point" option is enabled, pressing Shift will disable it for this click and viceversa.

Column mode editing (rectangular selections)

There is basic support for column mode editing. To use it, create a rectangular selection by holding downthe Control and Shift keys (or Control and Alt if it doesn't work) while selecting some text. It is also possibleto create a zero-column selection. Once a rectangular selection exists you can start editing the text withinthis selection and the modifications will be done for every line in the selection.

Drag and drop of text

If you drag selected text in the editor widget of Geany the text is moved to the position where the mousepointer is when releasing the mouse button. Holding Control when releasing the mouse button will copy thetext instead. This behaviour was changed in Geany 0.11 - before the selected text was copied to the newposition.

Indentation

Geany allows each document to indent either with a tab character or multiple spaces. The default indentmode is set in the Editor Features preferences (see the link for more information). But this can beoverridden using either the Document->Indent Type menu, or by using the Detect from file indentationpreference. When enabled, this scans each file that is opened and sets the indent mode based on howmany lines start with a tab vs. 2 or more spaces.

The indent mode for the current document is shown on the status bar as follows:

TABIndent with Tab characters.

SPIndent with spaces.

T/SIndent with tabs and spaces, depending on how much indentation is on a line.

Auto-indentation

When enabled, auto-indentation happens when pressing Enter in the Editor. It adds a certain amount ofindentation to the new line so the user doesn't always have to indent each line manually.

Geany has four types of auto-indentation:

NoneDisables auto-indentation completely.

BasicAdds the same amount of whitespace on a new line as on the last line.

Current charsDoes the same as Basic but also indents a new line after an opening brace '{', and de-indents whentyping a closing brace '}'. For Python, a new line will be indented after typing ':' at the end of theprevious line.

Match bracesSimilar to Current chars but the closing brace will be aligned to match the indentation of the line withthe opening brace.

Bookmarks

Geany provides a handy bookmarking feature that lets you mark one or more lines in a document, andreturn the cursor to them using a key combination.

To place a mark on a line, either left-mouse-click in the left margin of the editor window, or else use Ctrl-m.This will produce a small green plus symbol in the margin. You can have as many marks in a document asyou like. Click again (or use Ctrl-m again) to remove the bookmark. To remove all the marks in a givendocument, use "Remove Markers" in the Document menu.

To navigate down your document, jumping from one mark to the next, use Ctrl-. (control period). To go inthe opposite direction on the page, use Ctrl-, (control comma). Using the bookmarking feature togetherwith the commands to switch from one editor tab to another (Ctrl-PgUp/PgDn and Ctrl-Tab) provides aparticularly fast way to navigate around multiple files.

Code navigation history

To ease navigation in source files and especially between different files, Geany lets you jump betweendifferent navigation points. Currently, this works for the following:

Go to tag declarationGo to tag definitionSymbol list itemsBuild errorsMessage items

When using one of these actions, Geany remembers your current position and jumps to the new one. If youdecide to go back to your previous position in the file, just use "Navigate back a location". To get back tothe new position again, just use "Navigate forward a location". This makes it easier to navigate in e.g.foreign code and between different files.

Sending text through custom commands

You can define several custom commands in Geany and send the current selection to one of thesecommands using the "Edit->Format->Send Selection to" menu or keybindings. The output of thecommand will be used to replace the current selection. This makes it possible to use text formatting toolswith Geany in a general way. The selected text will be sent to the standard input of the executedcommand, so the command should be able to read from it and it should print all results to its standardoutput which will be read by Geany. To help finding errors in executing the command, the output of theprogram's standard error will be printed on Geany's standard output.

To add a custom command, just go to the Set Custom Commands dialog in the Format sub menu of theEdit and Popup menu. Then click on Add to get a new text entry and type the command. You can alsospecify some command line options. To delete a command, just clear the text entry and press OK. It will bedeleted automatically.

Context actions

You can execute the context action command on the current word at the cursor position or the availableselection. This word or selection can be used as an argument to the command. The context action isinvoked by a menu entry in the popup menu of the editor and also a keyboard shortcut (see the sectioncalled Keybindings).

The command can be specified in the preferences dialog and also for each filetype (see"context_action_cmd" in the section called Format). When the context action is invoked, the filetypespecific command is used if available, otherwise the command specified in the preferences dialog isexecuted.

The current word or selection can be referred with the wildcard "%s" in the command, it will be replaced bythe current word or selection before the command is executed.

For example a context action can be used to open API documentation in a browser window, the commandto open the PHP API documentation would be:

firefox "http://www.php.net/%s"

when executing the command, the %s is substituted by the word near the cursor position or by the currentselection. If the cursor is at the word "echo", a browser window will open(assumed your browser is calledfirefox) and it will open the address: http://www.php.net/echo.

Autocompletion

Geany can offer a list of possible completions for symbols defined in the tags and for all words in adocument.

The autocompletion list for symbols is presented when the first few characters of the symbol are typed(configurable, see Editor Completions preferences, default 4) or when the Complete word keybinding ispressed (configurable, see Editor keybindings, default Ctrl-Space).

When the defined keybinding is typed and the Autocomplete all words in document preference (in EditorCompletions preferences) is selected then the autocompletion list will show all matching words in thedocument, if there are no matching symbols.

If you don't want to use autocompletion it can be dismissed until the next symbol by pressing Escape. Theautocompletion list is updated as more characters are typed so that it only shows completions that startwith the characters typed so far. If no symbols begin with the sequence, the autocompletion window isclosed.

The up and down arrows will move the selected item. The highlighted item on the autocompletion list canbe chosen from the list by pressing Enter/Return. You can also double-click to select an item. The sequencewill be completed to match the chosen item, and if the Drop rest of word on completion preference is set(in Editor Completions preferences) then any characters after the cursor that match a symbol or word aredeleted.

Word part completion

By default, pressing Tab will complete the selected item by word part; useful e.g. for adding the prefixgtk_combo_box_entry_ without typing it manually:

gtk_com<TAB>gtk_combo_<TAB>gtk_combo_box_<e><TAB>gtk_combo_box_entry_<s><ENTER>gtk_combo_box_entry_set_text_column

The key combination can be changed from Tab - See Editor keybindings. If you clear/change the keycombination for word part completion, Tab will complete the whole word instead, like Enter.

Scope autocompletion

E.g.:

struct

{ int i; char c;} foo;

When you type foo. it will show an autocompletion list with 'i' and 'c' symbols.

It only works for languages that set parent scope names for e.g. struct members. Currently this means C-like languages. The C tag parser only parses global scopes, so this won't work for structs or objectsdeclared in local scope.

User-definable snippets

Snippets are small strings or code constructs which can be replaced or completed to a more complexstring. So you can save a lot of time when typing common strings and letting Geany do the work for you. Toknow what to complete or replace Geany reads a configuration file called snippets.conf at startup.

Maybe you need to often type your name, so define a snippet like this:

[Default]myname=Enrico Tröger

Every time you write myname <TAB> in Geany, it will replace "myname" with "Enrico Tröger". The key tostart autocompletion can be changed in the preferences dialog, by default it is TAB. The correspondingkeybinding is called Complete snippet.

The system-wide configuration file can be found in $prefix/share/geany, where $prefix is the pathwhere Geany is installed (see Installation prefix). It is not recommended to edit the system-wide file,because it will be overridden when Geany is updated.

To change the settings, copy the file from $prefix/share/geany in your configuration directory (usually~/.config/geany/).

For example:

% cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/

Then you can edit the file and the changes will remain available after an update of Geany because the fileresides in your configuration directory. Alternatively, you can create a file~/.config/geany/snippets.conf and add only these settings you want to change. All missing settingswill be read from the global snippets file in $prefix/share/geany.

The file snippets.conf contains sections defining snippets that are available for particular filetypes and ingeneral.

The two sections "Default" and "Special" apply to all filetypes. "Default" contains all snippets which areavailable for every filetype and "Special" contains snippets which can only be used in other snippets. So youcan define often used parts of snippets and just use the special snippet as a placeholder (see thesnippets.conf for details).

You can define sections with the name of a filetype eg "C++". The snippets in that section are onlyavailable for use in files with that filetype. Snippets in filetype sections will hide snippets with the samename in the "Default" section when used in a file of that filetype.

To define snippets you can use several special character sequences which will be replaced when using thesnippet:

Substitution Sequences for snippets

\n or %newline% Insert a new line (it will be replaced by the used EOL char(s): LF, CR/LF, or CR).

\t or %ws% Insert an indentation step, it will be replaced according to the current document'sindent mode.

\s \s to force whitespace at beginning or end of a value ('key= value' won't work, use'key=\svalue')

%cursor% Place the cursor at this position after completion has been done. You can definemultiple %cursor% wildcards and use the keybinding Move cursor in snippetto jump to the next defined cursor position in the completed snippet.

%...% "..." means the name of a key in the "Special" section. If you have defined a key"brace_open" in the "Special" section you can use %brace_open% in any othersnippet.

Snippet names must not contain spaces otherwise they won't work correctly. But beside that you candefine almost any string as a snippet and use it later in Geany. It is not limited to existing contructs ofcertain programming languages(like if, for, switch). Define whatever you need.

Since Geany 0.15 you can also use most of the available templates wildcards listed in Template wildcards.All wildcards which are listed as available in snippets can be used. For instance to improve the aboveexample:

[Default]myname=My name is {developer}

mysystem=My system: {command:uname -a}

this will replace myname with "My name is " and the value of the template preference developer.

You can change the way Geany recognizes the word to complete, that is how the start and end of a word isrecognised when the snippet completion is requested. The section "Special" may contain a key "wordchars"which lists all characters a string may contain to be recognized as a word for completion. Leave itcommented to use default characters or define it to add or remove characters to fit your needs.

Inserting Unicode characters

With GTK 2.10 and above, you can insert Unicode code points by hitting Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing the code point for the character you want and hit Enter or Return(still holding Ctrl-Shift). If you release Ctrl-Shift before hitting Enter or Return (or any other character), thecode insertion is completed, but the typed character is also entered. In the case of Enter/Return, it is anewline, as you might expect.

In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u in the keybinding preferences,then select Tools->Reload Configuration or restart Geany. Note that it works slightly differently from otherGTK applications, in that you'll need to continue to hold down the Ctrl and Shift keys while typing the codepoint hex digits (and the Enter or Return to finish the code point).

For GTK < 2.10, it is also possible, but typing the first Ctrl-Shift-u is not necessary. One problem is that youmay find the alphabetic keys conflict with other Geany keybindings.

Search, replace and go to

This section describes search-related commands from the Search menu and the editor window's popupmenu:

FindFind usage *Find in filesReplaceGo to tag definition *Go to tag declaration *Go to line

* These items are available from the editor window's popup menu, or by using a keyboard shortcut (seeSearch keybindings).

Toolbar entries

There are also two toolbar entries:

Search barGo to line entry

There are keybindings to focus each of these - see Focus keybindings. Pressing Escape will then focus theeditor.

Search bar

The quickest way to find some text is to use the search bar entry in the toolbar. This performs a case-insensitive search in the current document whilst you type. Pressing Enter will search again.

Find

The Find dialog is used for finding text in one or more open documents.

Matching options

The syntax for the Use regular expressions option is shown in Regular expressions.

Note

Use escape sequences is implied for regular expressions.

The Use escape sequences option will transform any escaped characters into their UTF-8 equivalent. Forexample, \t will be transformed into a tab character. Other recognized symbols are: \\, \n, \r, \uXXXX(Unicode characters).

Find all

To find all matches, click on the Find All expander. This will reveal several options:

In DocumentIn SessionMark

Find All In Document will show a list of matching lines in the current document in the Messages tab of theMessage Window. Find All In Session does the same for all open documents.

Mark will highlight all matches in the current document with a colored box. These markers can be removedby selecting the Remove Markers command from the Document menu.

Change font in search dialog text fields

All search related dialogs use a Monospace for the text input fields to increase the readability of input text.This is useful when you are typing input such as regular expressions with spaces, periods and commaswhich might it hard to read with a proportional font.

If you want to change the font, you can do this easily by inserting the following style into your .gtkrc-2.0(usually found in your home directory on UNIX-like systems and in the etc subdirectory of your Geanyinstallation on Windows):

style "search_style"{ font_name="Monospace 8"}widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"

Please note the addition of ":highest" in the last line which sets the priority of this style to the highestavailable. Otherwise, the style is ignored for the search dialogs.

Find usage

Find usage searches all open files. It is similar to the Find All In Session option in the Find dialog.

If there is a selection, then it is used as the search text; otherwise the current word is used. The currentword is either taken from the word nearest the edit cursor, or the word underneath the popup menu clickposition when the popup menu is used. The search results are shown in the Messages tab of the MessageWindow.

Find in files

Find in files is a more powerful version of Find usage that searches all files in a certain directory using theGrep tool. The Grep tool must be correctly set in Preferences to the path of the system's Grep utility. GNUGrep is recommended.

The Encoding combo box can be used to define the encoding of the files to be searched. The enteredsearch text is converted to the chosen encoding and the search results are converted back to UTF-8. TheExtra options field is used to pass any additional arguments to the grep tool.

Filtering out version control files

When using the Recurse in subfolders option with a directory that's under version control, you can set theExtra options field to filter out version control files.

If you have GNU Grep >= 2.5.2 you can use the --exclude-dir argument to filter out CVS and hiddendirectories like .svn.

Example: --exclude-dir=.svn --exclude-dir=CVS

If you have an older Grep, you can try using the --exclude flag to filter out filenames.

SVN Example: --exclude=*.svn-base

The --exclude argument only matches the file name part, not the path.

Replace

The Replace dialog is used for replacing text in one or more open documents.

The Replace dialog has the same options for matching text as the Find dialog. See the section Matchingoptions.

The Use regular expressions option allows regular expressions to be used in the search string and backreferences in the replacement text -- see the entry for '\n' in Regular expressions.

Replace all

To replace several matches, click on the Replace All expander. This will reveal several options:

In DocumentIn SessionIn Selection

Replace All In Document will replace all matching text in the current document. Replace All In Session doesthe same for all open documents. Replace All In Selection will replace all matching text in the currentselection of the current document.

Go to tag definition

If the current word is the name of a tag definition (like a function body) and the file containing the tagdefinition is open, this command will switch to that file and go to the corresponding line number. Thecurrent word is either the word nearest the edit cursor, or the word underneath the popup menu clickposition when the popup menu is used.

Go to tag declaration

Like Go to tag definition, but for a forward declaration such as a function prototype or extern declarationinstead of a function body.

Go to line

Go to a particular line number in the current file.

Regular expressions

You can use regular expressions in the Find and Replace dialogs by selecting the Use regular expressionscheck box (see Matching options). The syntax is POSIX compatible, as described in the table below.

Note

1. The Use escape sequences dialog option always applies for regular expressions.2. Searching backwards with regular expressions is not supported.3. \b, \d, \s, \w are GNU extensions and may not be available on non-GNU POSIX systems unless you

built Geany with the --enable-gnu-regex option (this is always used on Windows).

In a regular expression, the following characters are interpreted:

. Matches any character.

( This marks the start of a region for tagging a match.

) This marks the end of a tagged region.

\nWhere n is 1 through 9 refers to the first through ninth tagged region when searching orreplacing.

Searching for (Wiki)\1 matches WikiWiki.

If the search string was Fred([1-9])XXX and the replace string was Sam\1YYY, when applied toFred2XXX this would generate Sam2YYY.

\0 When replacing, the whole matching text.

\b This matches a word boundary.

\cA backslash followed by d, D, s, S, w or W, becomes a character class (both inside and outsidesets []).

d: decimal digitsD: any char except decimal digitss: whitespace (space, \t \n \r \f \v)S: any char except whitespace (see above)w: alphanumeric & underscoreW: any char except alphanumeric & underscore

\x This allows you to use a character x that would otherwise have a special meaning. Forexample, \[ would be interpreted as [ and not as the start of a character set. Use \\ for a literalbackslash.

[...]Matches one of the characters in the set. If the first character in the set is ^, it matches thecharacters NOT in the set, i.e. complements the set. A shorthand S-E (start dash end) is usedto specify a set of characters S up to E, inclusive.

The special characters ] and - have no special meaning if they appear first in the set. - canalso be last in the set. To include both, put ] first: []A-Z-].

Examples:

[]|-] matches these 3 chars[]-|] matches from ] to | chars[a-z] any lowercase alpha[^]-] any char except - and ][^A-Z] any char except uppercase alpha[a-zA-Z] any alpha

^ This matches the start of a line (unless used inside a set, see above).

$ This matches the end of a line.

* This matches 0 or more times. For example, Sa*m matches Sm, Sam, Saam, Saaam and soon.

+ This matches 1 or more times. For example, Sa+m matches Sam, Saam, Saaam and so on.

? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.

Note

This table is adapted from Scintilla and SciTE documentation, distributed under the License for Scintilla andSciTE.

Tags

Tags are information that relates symbols in a program with the source file location of the declaration anddefinition.

Geany has built-in functionality for generating tag information (aka "workspace tags") for supportedfiletypes when you open a file. You can also have Geany automatically load external tag files (aka "globaltags files") upon startup, or manually using Tools --> Load Tags.

Geany uses its own tag file format, similar to what ctags uses (but is incompatible with ctags). You useGeany to generate global tags files, as described below.

Workspace tags

Tags for each document are parsed whenever a file is loaded or saved. These are shown in the Symbol listin the Sidebar. These tags are also used for autocompletion of symbols and calltips for all documents openin the current session that have the same filetype.

The Go to Tag commands can be used with all workspace tags. See Go to tag definition.

Global tags

Global tags are used to provide autocompletion of symbols and calltips without having to open thecorresponding source files. This is intended for library APIs, as the tags file only has to be updated whenyou upgrade the library.

You can load a custom global tags file in two ways:

Using the Load Tags command in the Tools menu.By creating a directory ~/.config/geany/tags, and moving or symlinking the tags files therebefore starting Geany.By creating a directory $prefix/share/geany/tags, and moving or symlinking the tags files therebefore starting Geany. $prefix is the installation prefix (see Installation prefix).

You can either download these files or generate your own. They have the format:

name.lang_ext.tags

lang_ext is one of the extensions set for the filetype associated with the tags. See the section calledFiletype extensions for more information.

Default global tags files

For some languages, a list of global tags is loaded when the corresponding filetype is first used. Currentlythese are for:

C -- GTK+ and GLibPascalPHPHTML -- &symbol; completion, e.g. for ampersand, copyright, etc.LaTeXPython

Global tags file format

Global tags files can have two different formats:

Tagmanager formatPipe-separated format

The first line of global tags files should be a comment, introduced by # followed by a space and a string likeformat=pipe or format=tagmanager respectively, these are case-sensitive. This helps Geany to read thefile properly. If this line is missing, Geany tries to auto-detect the used format but this might fail.

The Tagmanager format is a bit more complex and is used for files created by the geany -g command.There is one tag per line. Different tag attributes like the return value or the argument list are separatedwith different characters indicating the type of the following argument.

The Pipe-separated format is easier to read and write. There is one tag per line and different tag attributesare separated by the pipe character (|). A line looks like:

basename|string|(string path [, string suffix])|

The first field is the tag name (usually a function name).The second field is the type of the return value.The third field is the argument list for this tag.The fourth field is the description for this tag but currently unused and should be left empty.

Except for the first field (tag name), all other field can be left empty but the pipe separator must appear forthem.

You can easily write your own global tag files using this format. Just save them in your tags directory, asdescribed earlier in the section Global tags.

Generating a global tags file

You can generate your own global tags files by parsing a list of source files. The command is:

geany -g [-P] <Tag File> <File list>

Tag File filename should be in the format described earlier -- see the section called Global tags.File list is a list of filenames, each with a full path (unless you are generating C/C++ tags and haveset the CFLAGS environment variable appropriately).-P or --no-preprocessing disables using the C pre-processor to process #include directives forC/C++ source files. Use this option if you want to specify each source file on the command-lineinstead of using a 'master' header file. Also can be useful if you don't want to specify the CFLAGSenvironment variable.

Example for the wxD library for the D programming language:

geany -g wxd.d.tags /home/username/wxd/wx/*.d

Generating C/C++ tag files:

For C/C++ tag files, gcc and grep are required, so that header files can be preprocessed to include anyother headers they depend upon.

For C/C++ files, the environment variable CFLAGS should be set with appropriate -I/path include paths.The following example works with the bash shell, generating tags for the GnomeUI library:

CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \

/usr/include/libgnomeui-2.0/gnome.h

You can adapt this command to use CFLAGS and header files appropriate for whichever libraries you want.

Replacing the default C/C++ tags file:

Geany currently uses a default global tags file c99.tags for C and C++, commonly installed in/usr/share/geany. This file can be replaced with one containing tags parsed from a different set of headerfiles. When Geany is next started, your custom tags file will be loaded instead of the default c99.tags. Youshould keep a copy of the generated tags file because it will get overwritten when upgrading Geany.

Ignore tags

You can also ignore certain tags if they would lead to wrong parsing of the code. Simply create a file called"ignore.tags" in your Geany configuration directory (usually ~/.config/geany/). Then list all tags you wantto ignore in this file, separated by spaces and/or newlines.

More detailed information about the usage from the Exuberant Ctags manual page:

Specifies a list of identifiers which are to be specially handledwhile parsing C and C++ source files. This option is specificallyprovided to handle special cases arising through the use ofpre-processor macros. When the identifiers listed are simple identifiers,these identifiers will be ignored during parsing of the source files.If an identifier is suffixed with a '+' character, ctags will alsoignore any parenthesis-enclosed argument list which may immediatelyfollow the identifier in the source files.If two identifiers are separated with the '=' character, the firstidentifiers is replaced by the second identifiers for parsing purposes.

For even more detailed information please read the manual page of Exuberant Ctags.

Preferences

You may adjust Geany's settings using the Edit --> Preferences dialog. Any changes you make there canbe applied by hitting either the Apply or the OK button. These settings will persist between Geany sessions.Note that most settings here have descriptive popup bubble help -- just hover the mouse over the item inquestion to get help on it.

You may also adjust some View settings (under the View menu) that persist between Geany sessions. Thesettings under the Document menu, however, are only for the current document and revert to defaultswhen restarting Geany.

There are also some rarer Hidden preferences.

Note

In the paragraphs that follow, the text describing a dialog tab comes after the screenshot of that tab.

General Startup preferences

Startup

Load files from the last sessionOn startup, load the same files you had open the last time you used Geany.

Load virtual terminal supportLoad the library for running a terminal in the message window area.

Enable plugin supportAllow plugins to be used in Geany.

Shutdown

Save window position and geometrySave the current position and size of the main window so next time you open Geany it's in the samelocation.

Confirm ExitHave a dialog pop up to confirm that you really want to quit Geany.

Paths

Startup pathPath to start in when opening or saving files. It must be an absolute path. Leave it blank to use thecurrent working directory.

Project filesPath to start in when opening project files.

Extra plugin pathBy default Geany looks in the global installation path and in the configuration directory. In additionthe path entered here will be searched for plugins. Usually you do not need to set an additional pathto search for plugins. It might be useful when Geany is installed on a multi-user machine andadditional plugins are available in a common location for all users. Leave blank to not set anadditional lookup path.

General Miscellaneous preferences

Miscellaneous

Beep on errors when compilation has finishedHave the computer make a beeping sound when compilation of your program has completed or anyerrors occurred.

Switch status message list at new messageSwitch to the status message tab (in the notebook window at the bottom) once a new statusmessage arrives.

Suppress status messages in the status bar

Remove all messages from the status bar. The messages are still displayed in the status messageswindow.

Tip

Another option is to use the Switch to Editor keybinding - it reshows the document statistics on thestatus bar. See Focus keybindings.

Use Windows File Open/Save dialogsDefines whether to use the native Windows File Open/Save dialogs or whether to use the GTK defaultdialogs.

Auto-focus widgets (focus follows mouse)Give the focus automatically to widgets below the mouse cursor. This works for the main editorwidget, the scribble, the toolbar search field goto line fields and the VTE.

Search

Always wrap search and hide the Find dialogAlways wrap search around the document and hide the Find dialog after clicking Find Next/Previous.

Use the current word under the cursor for Find dialogsUse current word under the cursor when opening the Find, Find in Files or Replace dialog and there isno selection. When this option is disabled, the search term last used in the appropriate Find dialog isused.

Use the current file's directory for Find in FilesWhen opening the Find in Files dialog, set the directory to search to the directory of the currentactive file. When this option is disabled, the directory of the last use of the Find in Files dialog is used.

Projects

Use project-based session filesSave your current session when closing projects. You will be able to resume different projectsessions, automatically opening the files you had open previously.

Store project file inside the project base directoryWhen creating new projects, the default path for the project file contains the project base path.Without this option enabled, the default project file path is one level above the project base path. Ineither case, you can easily set the final project file path in the New Project dialog. This optionprovides the more common defaults automatically for convenience.

Interface preferences

Sidebar

Show sidebarWhether to show the sidebar at all.

Show symbol listShow the list of functions, variables, and other information in the current document you are editing.

Show documents listShow all the documents you have open currently. This can be used to change between documents(see Switching between documents) and to perform some common operations such as saving,closing and reloading.

PositionWhether to place the sidebar on the left or right of the editor window.

Fonts

EditorChange the font used to display documents.

Symbol listChange the font used for the Symbols sidebar tab.

Message windowChange the font used for the message window area.

Editor tabs

Show editor tabsShow a notebook tab for all documents so you can switch between them using the mouse (insteadof using the Documents window).

Show close buttonsMake each tab show a close button so you can easily close open documents.

Placement of new file tabsWhether to create a document with its notebook tab to the left or right of all existing tabs.

Next to currentWhether to place file tabs next to the current tab rather than at the edges of the notebook.

Double-clicking hides all additional widgetsWhether to call the View->Toggle All Additional Widgets command when double-clicking on anotebook tab.

Tab positions

EditorSet the positioning of the editor's notebook tabs to the right, left, top, or bottom of the editingwindow.

Sidebar

Set the positioning of the sidebar's notebook tabs to the right, left, top, or bottom of the sidebarwindow.

Message windowSet the positioning of the message window's notebook tabs to the right, left, top, or bottom of themessage window.

Miscellaneous

Show status barShow the status bar at the bottom of the main window. It gives information about the file you areediting like the line and column you are on, whether any modifications were done, the file encoding,the filetype and other information.

Toolbar preferences

Affects the main toolbar underneath the menu bar.

Toolbar

Show ToolbarWhether to show the toolbar.

Append Toolbar to the MenuAllows to append the toolbar to the main menu bar instead of placing it below. This is useful to savevertical space.

Customize ToolbarSee Customizing the toolbar.

Appearance

Icon StyleSelect the toolbar icon style to use - either icons and text, just icons or just text. The choice Systemdefault uses whatever icon style is set by GTK.

Icon sizeSelect the size of the icons you see (large, small or very small). The choice System default useswhatever icon size is set by GTK.

Editor Features preferences

Features

Line wrappingShow long lines wrapped around to new display lines.

Enable "smart" home keyWhether to move the cursor to the first non-whitespace character on the line when you hit the homekey on your keyboard. Pressing it again will go to the very start of the line.

Disable Drag and DropDo not allow the dragging and dropping of selected text in documents.

Enable foldingAllow groups of lines in a document to be collapsed for easier navigation/editing.

Fold/Unfold all children of a fold pointWhether to fold/unfold all child fold points when a parent line is folded.

Use indicators to show compile errorsUnderline lines with compile errors using red squiggles to indicate them in the editor area.

Newline strip trailing spacesRemove any white space at the end of the line when you hit the Enter/Return key.

Line breaking columnThe editor column number to insert a newline at when Line Breaking is enabled for the currentdocument.

Comment toggle markerA string which is added when toggling a line comment in a source file. It is used to mark thecomment as toggled.

Editor Indentation preferences

Indentation group

See Indentation for more information.

Type

When Geany inserts indentation, whether to use:

Just TabsJust SpacesTabs and Spaces, depending on how much indentation is on a line

The Tabs and Spaces indent type is also known as Soft tab support in some other editors.

WidthThe width of a single indent size in spaces. By default the indent size is equivalent to 4 spaces.

Detect from fileTry to detect and set the indent type based on file content, when a file is opened.

Auto-indent mode

The type of auto-indentation you wish to use after pressing Enter, if any.

BasicJust add the indentation of the previous line.

Current charsAdd indentation based on the current filetype and any characters at the end of the line suchas {, } for C, : for Python.

Match bracesLike Current chars but for C-like languages, make a closing } brace line up with the matchingopening brace.

Tab key indents

If set, pressing tab will indent the current line or selection, and unindent when pressing Shift-tab.Otherwise, the tab key will insert a tab character into the document (which can be different fromindentation, depending on the indent type).

Note

There are also separate configurable keybindings for indent & unindent, but this preference allowsthe tab key to have different meanings in different contexts - e.g. for snippet completion.

Editor Completions preferences

Completions

Snippet CompletionWhether to replace special keywords after typing Tab into a pre-defined text snippet. See User-definable snippets.

XML tag autocompletionWhen you open an XML tag automatically generate its completion tag.

Automatic continuation multi-line comments

Continue automatically multi-line comments in languages like C, C++ and Java when a new line isentered inside such a comment. With this option enabled, Geany will insert a * on every new lineinside a multi-line comment, for example when you press return in the following C code:

/* * This is a C multi-line comment, press <Return>

then Geany would insert:

*

on the next line with the correct indentation based on the previous line, as long as the multi-line isnot closed by */.

Autocomplete symbolsWhen you start to type a symbol name, look for the full string to allow it to be completed for you.

Autocomplete all words in documentWhen you start to type a word, Geany will search the whole document for words starting with thetyped part to complete it, assuming there are no tag names to show.

Drop rest of word on completionRemove any word part to the right of the cursor when choosing a completion list item.

Characters to type for autocompletionNumber of characters of a word to type before autocompletion is displayed.

Completion list heightThe number of rows to display for the autocompletion window.

Max. symbol name suggestionsThe maximum number of items in the autocompletion list.

Auto-close quotes and brackets

Geany can automatically insert a closing bracket and quote characters when you open them. For instance,you type a ( and Geany will automatically insert ). With the following options, you can define for whichcharacters this should work.

Parenthesis ( )Auto-close parenthesis when typing an opening one

Curly brackets { }Auto-close curly brackets (braces) when typing an opening one

Square brackets [ ]Auto-close square brackets when typing an opening one

Single quotes ' 'Auto-close single quotes when typing an opening one

Double quotes " "Auto-close double quotes when typing an opening one

Editor Display preferences

This is for visual elements displayed in the editor window.

Display

Invert syntax highlighting colorsInvert all colors, by default this makes white text on a black background.

Show indendation guidesShow vertical lines to help show how much leading indentation there is on each line.

Show whitespacesMark all tabs with an arrow "-->" symbol and spaces with dots to show which kinds of whitespace areused.

Show line endingsDisplay a symbol everywhere that a carriage return or line feed is present.

Show line numbersShow or hide the Line Number margin.

Show markers marginShow or hide the small margin right of the line numbers, which is used to mark lines.

Stop scrolling at last lineWhen enabled Geany stops scrolling when at the last line of the document. Otherwise you can scrollone more page even if there are no real lines.

Long line marker

The long line marker helps to indicate overly-long lines, or as a hint to the user for when to break the line.

Type

LineShow a thin vertical line in the editor window at the given column position.

BackgroundChange the background color of characters after the given column position to the color setbelow. (This is recommended over the Line setting if you use proportional fonts).

DisabledDon't mark long lines at all.

Long line markerSet this value to a value greater than zero to specify the column where it should appear.

Long line marker color

Set the color of the long line marker.

Virtual spaces

Virtual space is space beyond the end of each line. The cursor may be moved into virtual space but no realspace will be added to the document until there is some text typed or some other text insertion commandis used.

DisabledDo not show virtual spaces

Only for rectangular selectionsOnly show virtual spaces beyond the end of lines when drawing a rectangular selection

AlwaysAlways show virtual spaces beyond the end of lines

Files preferences

New files

Open new documents from the command-lineWhether to create new documents when passing filenames that don't exist from the command-line.

Default encoding (new files)The type of file encoding you wish to use when creating files.

Used fixed encoding when opening filesAssume all files you are opening are using the type of encoding specified below.

Default encoding (existing files)Opens all files with the specified encoding instead of auto-detecting it. Use this option when it's notpossible for Geany to detect the exact encoding.

Default end of line charactersThe end of line characters to which should be used for new files. On Windows systems, you generallywant to use CR/LF which are the common characters to mark line breaks. On Unix-like systems, LF isdefault and CR is used on MAC systems.

Saving files

Perform formatting operations when a document is saved. These can each be undone with the Undocommand.

Ensure newline at file endAdd a newline at the end of the document if one is missing.

Strip trailing spacesRemove the trailing spaces on each line of the document.

Replace tabs by space

Replace all tabs in the document with the equivalent number of spaces.

Note

It is better to use spaces to indent than use this preference - see Indentation.

Miscellaneous

Recent files list lengthThe number of files to remember in the recently used files list.

Disk check timeout

The number of seconds to periodically check the current document's file on disk in case it haschanged. Setting it to 0 will disable this feature.

Note

These checks are only performed on local files. Remote files are not checked for changes due toperformance issues (remote files are files in ~/.gvfs/).

Tools preferences

Tool paths

TerminalThe location of your terminal executable.

BrowserThe location of your web browser executable.

GrepThe location of the grep executable.

Note

For Windows users: at the time of writing it is recommended to use the grep.exe from the UnxUtils project(http://sourceforge.net/projects/unxutils). The grep.exe from the Mingw project for instance might not workwith Geany at the moment.

Commands

Context actionSet this to a command to execute on the current word. You can use the "%s" wildcard to pass thecurrent word below the cursor to the specified command.

Template preferences

This data is used as meta data for various template text to insert into a document, such as the file header.You only need to set fields that you want to use in your template files.

Note

For changes made here to take effect, you must either select Tools->Reload Configuration or restart

Geany.

Template data

DeveloperThe name of the developer who will be creating files.

InitialsThe initials of the developer.

Mail address

The email address of the developer.

Note

You may wish to add anti-spam markup, e.g. name<at>site<dot>ext.

CompanyThe company the developer is working for.

Initial versionThe initial version of files you will be creating.

YearSpecify a format for the the {year} wildcard. You can use any conversion specifiers which can beused with the ANSI C strftime function. For details please see http://man.cx/strftime.

DateSpecify a format for the the {date} wildcard. You can use any conversion specifiers which can beused with the ANSI C strftime function. For details please see http://man.cx/strftime.

Date & TimeSpecify a format for the the {datetime} wildcard. You can use any conversion specifiers which can beused with the ANSI C strftime function. For details please see http://man.cx/strftime.

Keybinding preferences

There are some commands listed in the keybinding dialog that are not, by default, bound to a keycombination, and may not be available as a menu item.

Note

For more information see the section Keybindings.

Printing preferences

Use external command for printingUse a system command to print your file out.

Use native GTK printingLet the GTK GUI toolkit handle your print request.

Print line numbers

Print the line numbers on the left of your paper.Print page number

Print the page number on the bottom right of your paper.Print page header

Print a header on every page that is sent to the printer.Use base name of the printed file

Don't use the entire path for the header, only the filename.Date format

How the date should be printed. You can use the same format specifiers as in the ANSI C functionstrftime(). For details please see http://man.cx/strftime.

Terminal (VTE) preferences

See also: Virtual terminal emulator widget (VTE).

Terminal widget

Terminal fontSelect the font that will be used in the terminal emulation control.

Foreground colorSelect the font color.

Background colorSelect the background color of the terminal.

Scrollback linesThe number of lines buffered so that you can scroll though the history.

ShellThe location of the shell on your system.

Scroll on keystrokeScroll the terminal to the prompt line when pressing a key.

Scroll on outputScroll the output down.

Cursor blinksLet the terminal cursor blink.

Override Geany keybindingsAllow the VTE to receive keyboard shortcuts (apart from focus commands).

Disable menu shortcut key (F10 by default)Disable the menu shortcut when you are in the virtual terminal.

Follow path of the current fileMake the path of the terminal change according to the path of the current file.

Execute programs in VTEExecute programs in the virtual terminal instead of using the external terminal tool. Note that if yourun multiple execute commands at once the output may become mixed together in the VTE.

Don't use run scriptDon't use the simple run script which is usually used to display the exit status of the executedprogram. This can be useful if you already have a program running in the VTE like a Python console(e.g. ipython). Use this with care.

Project Management

Project Management is optional in Geany. Currently it can be used for:

Storing and opening session files on a project basis.Configuring the Build menu on a project basis.

A list of session files can be stored and opened with the project when the Use project-based session filespreference is enabled, in the Project group of the Preferences dialog.

As long as a project is open, the Build menu will use the items defined in project's settings, instead of thedefaults. See Build Menu Configuration for information on configuring the menu.

The current project's settings are saved when it is closed, or when Geany is shutdown. When restartingGeany, the previously opened project file that was in use at the end of the last session will be reopened.

The project menu items are detailed below.

New Project

To create a new project, fill in the Name field. By default this will setup a new project file~/projects/name.geany. Usually it's best to store all your project files in the same directory (they areindependent of any source directory trees).

The Base path text field is setup to use ~/projects/name. This can safely be set to any existing path -- itwill not touch the file structure contained in it.

Project Properties

You can set an optional description for the project, but it is not used elsewhere by Geany.

The Base path field is used as the directory to run the Build menu commands. The specified path can bean absolute path or it is considered to be relative to the project's file name.

Set Base Path Button

This button is a convenience to set the working directory fields in the non-filetype Build menu items to %pto use the project base path.

Note

Pressing the 'set' button will override any working directories you have configured for the project.

Open Project

The Open command displays a standard file chooser, starting in ~/projects. Choose a project file namedwith the .geany extension.

When project session support is enabled, Geany will close the currently open files and open the sessionfiles associated with the project.

Close Project

Project file settings are saved when the project is closed.

When project session support is enabled, Geany will close the project session files and open any previouslyclosed default session files.

Build Menu

After editing code with Geany, the next step is to compile, link, build, interpret, run etc. As Geany supportsmany languages each with a different approach to such operations, and as there are also many languageindependent software building systems, Geany does not have a built-in build system, nor does it limit whichsystem you can use. Instead the build menu provides a configurable and flexible means of running anyexternal commands to execute your preferred build system.

This section provides a description of the default configuration of the build menu and then covers how toconfigure it, and where the defaults fit in.

Running the commands from within Geany has two benefits:

The current file is automatically saved before the command is run.The output is captured in the Compiler notebook tab and parsed for warnings or errors.

Warnings and errors that can be parsed for line numbers will be shown in red in the Compiler tab and youcan click on them to switch to the relevant source file (or open it) and mark the line number. Also lines withwarnings or errors are marked in the source, see Indicators below.

Tip

If Geany's default error message parsing does not parse errors for the tool you're using, you can set acustom regex in the Build Commands Dialog, see Build Menu Configuration.

Indicators

Indicators are red squiggly underlines which are used to highlight errors which occurred while compiling thecurrent file. So you can easily see where your code failed to compile. You can remove them by selectingRemove Error Indicators in the Document menu.

If you do not like this feature, you can disable it - see Editor Features preferences.

Default Build Menu Items

Depending on the current file's filetype, the default Build menu will contain the following items:

CompileBuildMake AllMake Custom TargetMake ObjectNext ErrorPrevious ErrorExecuteSet Build Menu Commands

Compile

The Compile command has different uses for different kinds of files.

For compilable languages such as C and C++, the Compile command is set up to compile the currentsource file into a binary object file.

Java source files will be compiled to class file bytecode.

Interpreted languages such as Perl, Python, Ruby will compile to bytecode if the language supports it, or willrun a syntax check, or if that is not available will run the file in its language interpreter.

Build

For compilable languages such as C and C++, the Build command will link the current source file'sequivalent object file into an executable. If the object file does not exist, the source will be compiled andlinked in one step, producing just the executable binary.

Interpreted languages do not use the Build command.

Note

If you need complex settings for your build system, or several different settings, then writing a Makefile andusing the Make commands is recommended; this will also make it easier for users to build your software.

Make

This runs "make" in the same directory as the current file.

Make custom target

This is similar to running 'Make' but you will be prompted for the make target name to be passed to theMake tool. For example, typing 'clean' in the dialog prompt will run "make clean".

Make object

Make object will run "make current_file.o" in the same directory as the current file, using the filename for'current_file'. It is useful for building just the current file without building the whole project.

Next Error

The next error item will move to the next detected error in the file.

Previous Error

The previous error item will move to the previous detected error in the file.

Execute

Execute will run the corresponding executable file, shell script or interpreted script in a terminal window.Note that the Terminal tool path must be correctly set in the Tools tab of the Preferences dialog - you canuse any terminal program that runs a Bourne compatible shell and accept the "-e" command lineargument to start a command or can be selected to use the built-in VTE if it is available - see Virtualterminal emulator widget (VTE).

After your program or script has finished executing, you will be prompted to press the return key. Thisallows you to review any text output from the program before the terminal window is closed.

Note

The execute command output is not parsed for errors.

Stopping running processes

When there is a running program, the Execute menu item in the menu and the Run button in the toolbareach become a stop button so you can stop the current running program (and any child processes). Thisworks by sending the SIGQUIT signal to the process.

Depending on the process you started it is possible that the process cannot be stopped. For example thiscan happen when the process creates more than one child process.

Terminal emulators

Xterm is known to work properly. If you are using "Terminal" (the terminal program of Xfce), you should addthe command line option --disable-server otherwise the started process cannot be stopped. Just addthis option in the preferences dialog on the Tools tab in the terminal field.

Set Build Commands

By default the Compile and Build commands invoke the GCC compiler and linker with only the basicarguments needed by all programs. Using Set Build Commands you can add any include paths andcompile flags for the compiler, any library names and paths for the linker, and any arguments you want touse when running Execute.

Build Menu Configuration

The build menu has considerable flexibility and configurability, allowing both menu labels the commandsthey execute and the directory they execute in to be configured.

For example, if you change one of the default make commands to run say 'waf' you can also change thelabel to match.

These settings are saved automatically when Geany is shut down.

The build menu is divided into four groups of items each with different behaviors:

File items - are configurable and depend on the filetype of the current document; they captureoutput in the compiler tab and parse it for errors.

Non-file items - are configurable and mostly don't depend on the filetype of the current document;they also capture output in the compiler tab and parse it for errors.

Execute items - are configurable and intended for executing your program or other long runningprograms. The output is not parsed for errors and is directed to the terminal selected in preferences.

Fixed items - these perform built-in actions:Go to the next error.Go to the previous error.Show the build menu commands dialog.

The maximum numbers of items in each of the configurable groups can be configured when Geany startsusing hidden settings (see Preferences File Format). Even though the maximum number of items mayhave been increased, only those menu items that have values configured are shown in the menu.

The groups of menu items obtain their configuration from four potential sources. The highest prioritysource that has the menu item defined will be used. The sources in decreasing priority are:

A project file if openThe user preferencesThe system filetype definitionsThe defaults

The detailed relationships between sources and the configurable menu item groups is shown in thefollowing table.

Group Project File PreferencesSystemFiletype Defaults

FiletypeLoads From:project file

Saves To: projectfile

Loads From:filetype.xxx file in~/.config/geany/filedefs

Saves to: as above,creating if needed.

Loads From:filetype.xxx inGeany install

Saves to: asuser preferencesleft.

None

Non-FiletypeLoads From:project file

Saves To: projectfile

Loads From:geany.conf file in~/.config/geany

Saves to: as above,

Loads From:filetype.xxx inGeany install

Saves to: as

1:Label: _MakeCommand: make

2:Label: Make Custom

creating if needed. user preferencesleft.

Label: Make Custom_Target Command:make

3:Label: Make _ObjectCommand: make%e.o

ExecuteLoads From:project file or elsefiletype defined inproject file

Saves To: projectfile

Loads From:geany.conf file in~/.config/geany or elsefiletype.xxx file in~/.config/geany/filedefs

Saves To: filetype.xxxfile in~/.config/geany/filedefs

Loads From:filetype.xxx inGeany install

Saves To: asuser preferencesleft

Label: _Execute Command:./%e

The following notes on the table reference cells by coordinate as (group,source):

General - for filetype.xxx substitute the filetype name of the current document for xxx.System Filetypes - Labels loaded from these sources are locale sensitive and can containtranslations.(Filetype, Project File) and (Filetype, Preferences) - preferences use a full filetype file so that userscan configure all other filetype preferences as well. Projects can only configure menu items perfiletype. Saving in the project file means that there is only one file per project not a whole directory.(Non-Filetype, System Filetype) - although conceptually strange, defining non-filetype commands ina filetype file, this provides the ability to define filetype dependent default menu items.(Execute, Project File) and (Execute, Preferences) - the project filetype based execute configurationand preferences non-filetype based execute can only be set by hand editing the appropriate file, seePreferences File Format and Project File Format.

Build Menu Commands Dialog

Most of the configuration of the build menu is done through the Build Menu Commands Dialog. You edit theconfiguration sourced from preferences in the dialog opened from the Build->Build Menu Commands itemand you edit the configuration from the project in the build tab of the project preferences dialog. Both usethe same form shown below.

The dialog is divided into three sections:

Filetype menu items which will be selected based on the filetype of the currently open document.Non-filetype menu items.Execute menu items.

The filetype and non-filetype sections also each contain a field for the regular expression used for parsingcommand output for error and warning messages.

The columns in the first three sections allow setting of the label, command, and working directory to runthe command in.

An item with an empty label will not be shown in the menu.

An empty working directory will default to the directory of the current document. If there is no currentdocument then the command will not run.

The dialog will always show the command selected by priority, not just the commands configured in thisconfiguration source. This ensures that you always see what the menu item is going to do if activated.

If the current source of the menu item is higher priority than the configuration source you are editing thenthe command will be shown in the dialog but will be insensitive (greyed out). This can't happen with theproject source but can with the preferences source dialog.

The clear buttons remove the definition from the configuration source you are editing. When you do thisthe command from the next lower priority source will be shown. To hide lower priority menu items withouthaving anything show in the menu configure with a nothing in the label but at least one character in thecommand.

Substitutions in Commands and Working Directories

The first occurance of each of the following character sequences in each of the command and workingdirectory fields is substituted by the items specified below before the command is run.

%d - substituted by the absolute path to the directory of the current file.%e - substituted by the name of the current file without the extension or path.%f - substituted by the name of the current file without the path.%p - if a project is open, substituted by the base path from the project.

Note

If the basepath set in the project preferences is not an absolute path , then it is taken as relative to thedirectory of the project file. This allows a project file stored in the source tree to specify all commands andworking directories relative to the tree itself, so that the whole tree including the project file, can be movedand even checked into and out of version control without having to re-configure the build menu.

Build Menu Keyboard Shortcuts

Keyboard shortcuts can be defined for the first two filetype menu items, the first three non-filetype menuitems, the first two execute menu items and the fixed menu items. In the keybindings configuration dialog(see Keybinding preferences) these items are identified by the default labels shown in the Build Menusection above.

It is currently not possible to bind keyboard shortcuts to more than these menu items.

You can also use underlines in the labels to set mnemonic characters.

Configuration Files

The configurable Build Menu capability was introduced in Geany 0.19 and required a new section to beadded to the configuration files (See Preferences File Format). Geany will still load older format project,preferences and filetype file settings and will attempt to map them into the new configuration format.There is not a simple clean mapping between the formats. The mapping used produces the most sensibleresults for the majority of cases. However, if they do not map the way you want, you may have to manuallyconfigure some settings using the Build Commands Dialog or the Build tab of the project preferencesdialog.

Any setting configured in either of these dialogs will override settings mapped from older formatconfiguration files.

Printing support

Since Geany 0.13 there has been printing support using GTK's printing API. The printed page(s) will looknearly the same as on your screen in Geany. Additionally, there are some options to modify the printedpage(s).

Note

The background text color is set to white, except for text with a white foreground. This allows dark colorschemes to save ink when printing.

You can define whether to print line numbers, page numbers at the bottom of each page and whether toprint a page header on each page. This header contains the filename of the printed document, the currentpage number and the date and time of printing. By default, the file name of the document with full pathinformation is added to the header. If you prefer to add only the basename of the file(without any pathinformation) you can set it in the preferences dialog. You can also adjust the format of the date and timeadded to the page header. The available conversion specifiers are the same as the ones which can beused with the ANSI C strftime function.

All of these settings can also be changed in the print dialog just before actual printing is done. On Unix-likesystems the provided print dialog offers a print preview. The preview file is opened with a PDF viewer and bydefault GTK uses evince for print preview. If you have not installed evince or just want to use another PDFviewer, you can change the program to use in the file .gtkrc-2.0 (usually found in your home directory).Simply add a line like:

gtk-print-preview-command = "epdfview %f"

at the end of the file. Of course, you can also use xpdf, kpdf or whatever as the print preview command.

Unfortunately, native GTK printing support is only available if Geany was built against GTK 2.10 (or above)and is running with GTK 2.10 (or above). If not, Geany provides basic printing support. This means you canprint a file by passing the filename of the current file to a command which actually prints the file. However,the printed document contains no syntax highlighting. You can adjust the command to which the filenameis passed in the preferences dialog. The default command is:

% lpr %f

%f will be substituted by the filename of the current file. Geany will not show errors from the commanditself, so you should make sure that it works before(e.g. by trying to execute it from the command line).

A nicer example, which many prefer is:

% a2ps -1 --medium=A4 -o - %f | xfprint4

But this depends on a2ps and xfprint4. As a replacement for xfprint4, gtklp or similar programs can beused.

Plugins

Plugins are loaded at startup, if the Enable plugin support general preference is set. There is also acommand-line option, -p, which prevents plugins being loaded. Plugins are scanned in the followingdirectories:

$prefix/lib/geany (see Installation prefix)~/.config/geany/plugins

Most plugins add menu items to the Tools menu when they are loaded.

Since Geany 0.13, there is a Plugin Manager to let you choose which plugins should be loaded at startup.You can also load and unload plugins on the fly using this dialog. Once you click the checkbox for a specificplugin in the dialog, it is loaded or unloaded according to its previous state. By default, no plugins areloaded at startup until you select some. You can also configure some plugin specific options when theplugin provides some.

See also Plugin documentation for information about single plugins which are included in Geany.

Keybindings

Geany supports the default keyboard shortcuts for the Scintilla editing widget. For a list of thesecommands, see Scintilla keyboard commands. The Scintilla keyboard shortcuts will be overridden by anycustom keybindings with the same keyboard shortcut.

Switching documents

There are a few non-configurable bindings to switch between documents, listed below. These can also beoverridden by custom keybindings.

Key Action

Alt-[1-9] Select left-most tab, from 1 to 9.

Alt-0 Select right-most tab.

Ctrl-Shift-PgUp Select left-most tab.

Ctrl-Shift-PgDn Select right-most tab.

Configurable keybindings

For all actions listed below you can define your own keybindings. Open the Preferences dialog, select thedesired action and click on change. In the resulting dialog you can press the key combination you want toassign to the action and it will be saved when you press OK. You can define only one key combination foreach action and each key combination can only be defined for one action.

Some of the default key combinations are common across many applications, for example Ctrl-N for Newand Ctrl-O for Open. Because they are so common it is not advisable to change these, but you can addother key combinations for these actions. For example Ctrl-O is set to execute menu_open by default, butyou can also define Alt-O, so that the file open dialog is shown by pressing either Ctrl-O or Alt-O.

The following tables list all customizable keyboard shortcuts, those which are common to manyapplications are marked with (C) after the shortcut.

File keybindings

Action Default shortcut Description

New Ctrl-N (C) Creates a new file.

Open Ctrl-O (C) Opens a file.

Open selected file Ctrl-Shift-O Opens the selected filename.

Re-open last closed tab Re-opens the last closed document tab.

Save Ctrl-S (C) Saves the current file.

Save As Saves the current file under a new name.

Save all Ctrl-Shift-S Saves all open files.

Close all Ctrl-Shift-W Closes all open files.

Close Ctrl-W (C) Closes the current file.

Reload file Ctrl-R (C) Reloads the current file. All unsaved changes willbe lost.

Print Ctrl-P (C) Prints the current file.

Editor keybindings

Action Default shortcut Description

Undo Ctrl-Z (C) Un-does the last action.

Redo Ctrl-Y Re-does the last action.

Delete current line(s) Ctrl-K Deletes the current line (and any lines with aselection).

Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to theend of the current line.

Duplicate line or selection Ctrl-D Duplicates the current line or selection.

Transpose current line Ctrl-T Transposes the current line with the previousone.

Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of theview. The cursor position and or an existingselection will not be changed.

Scroll up by one line Alt-Up Scrolls the view.

Scroll down by one line Alt-Down Scrolls the view.

Complete word Ctrl-Space Shows the autocompletion list. If alreadyshowing tag completion, it shows documentword completion instead, even if it is not enabledfor automatic completion. Likewise if no tagsuggestions are available, it shows documentword completion.

Show calltip Ctrl-Shift-Space Shows a calltip for the current function ormethod.

Show macro list Ctrl-Return Shows a list of available macros and variables inthe workspace.

Complete snippet Tab If you type a construct like if or for and press thiskey, it will be completed with a matchingtemplate.

Suppress snippet completion If you type a construct like if or for and press thiskey, it will not be completed, and a space or tabwill be inserted, depending on what the constructcompletion keybinding is set to. For example, ifyou have set the construct completionkeybinding to space, then setting this toShift+space will prevent construct completionand insert a space.

Context Action Executes a command and passes the currentword (near the cursor position) or selection asan argument. See the section called Contextactions.

Move cursor in snippet Jumps to the next defined cursor positions in acompleted snippets if multiple cursor positionswhere defined.

Word part completion Tab When the autocompletion list is visible, completethe currently selected item up to the next wordpart.

Move line(s) up Move the current line or selected lines up by oneline.

Move line(s) down Move the current line or selected lines down byone line.

Clipboard keybindings

Action Default shortcut Description

Cut Ctrl-X (C) Cut the current selection to the clipboard.

Copy Ctrl-C (C) Copy the current selection to the clipboard.

Paste Ctrl-V (C) Paste the clipboard text into the currentdocument.

Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with aselection) to the clipboard.

Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with aselection) to the clipboard.

Select keybindings

Action Default shortcut Description

Select all Ctrl-A (C) Makes a selection of all text in the currentdocument.

Select current word Alt-Shift-W Selects the current word under the cursor.

Select current paragraph Alt-Shift-P Selects the current paragraph under the cursorwhich is defined by two empty lines around it.

Select current line(s) Alt-Shift-L Selects the current line under the cursor (andany partially selected lines).

Select to previous word part (Extend) selection to previous word partboundary.

Select to next word part (Extend) selection to next word part boundary.

Insert keybindings

Action Default shortcut Description

Insert date Shift-Alt-D Inserts a customisable date.

Insert alternative whitespace Inserts a tab character when spaces should beused for indentation and inserts spacecharacters of the amount of a tab width whentabs should be used for indentation.

Format keybindings

Action Default shortcut Description

Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercaseselection will be changed into uppercase andvice versa. If the selection contains lower- anduppercase characters, all will be converted tolowercase.

Comment line Comments current line or selection.

Uncomment line Uncomments current line or selection.

Toggle line commentation Ctrl-E Comments a line if it is not commented orremoves a comment if the line is commented.

Increase indent Ctrl-I Indents the current line or selection by one tabor by spaces in the amount of the tab widthsetting.

Decrease indent Ctrl-U Removes one tab or the amount of spaces ofthe tab width setting from the indentation of thecurrent line or selection.

Increase indent by one space Indents the current line or selection by onespace.

Decrease indent by onespace

Deindents the current line or selection by onespace.

Smart line indent Indents the current line or all selected lines withthe same indentation as the previous line.

Send to Custom Command 1(2,3)

Ctrl-1 (2,3) Passes the current selection to a configuredexternal command (available for the first threeconfigured commands, see Sending textthrough custom commands for details).

Send Selection to Terminal Sends the current selection or the current line (ifthere is no selection) to the embedded Terminal(VTE).

Reflow lines/block Reformat selected lines or current (indented)text block, breaking lines at the long line markeror the line breaking column if line breaking isenabled for the current document.

Settings keybindings

Action Default shortcut Description

Preferences Ctrl-Alt-P Opens preferences dialog.

Plugin Preferences Opens plugin preferences dialog.

Search keybindings

Action Default shortcut Description

Find Ctrl-F (C) Opens the Find dialog.

Find Next Ctrl-G Finds next result.

Find Previous Ctrl-Shift-G Finds previous result.

Replace Ctrl-H (C) Opens the Replace dialog.

Find in files Ctrl-Shift-F Opens the Find in files dialog.

Next message Jumps to the line with the next message in theMessages window.

Previous message Jumps to the line with the previous message inthe Messages window.

Find Usage Finds all occurrences of the current word (nearthe keyboard cursor) or selection in all opendocuments and displays them in the messageswindow.

Find Document Usage Finds all occurrences of the current word (nearthe keyboard cursor) or selection in the currentdocument and displays them in the messageswindow.

Mark All Ctrl-Shift-M Highlight all matches of the currentword/selection in the current document with acolored box. If there's nothing to find, highlightedmatches will be cleared.

Go to keybindings

Action Default shortcut Description

Navigate forward a location Switches to the next location in the navigationhistory. See the section called Code NavigationHistory.

Navigate back a location Switches to the previous location in thenavigation history. See the section called Codenavigation history.

Go to line Ctrl-L Focuses the Go to Line entry (if visible) or showsthe Go to line dialog.

Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then itis moved to the brace which belongs to thecurrent one. If this keyboard shortcut is pressedagain, the cursor is moved back to the firstbrace.

Toggle marker Ctrl-M Set a marker on the current line, or clear themarker if there already is one.

Goto next marker Ctrl-. Goto the next marker in the current document.

Goto previous marker Ctrl-, Goto the previous marker in the currentdocument.

Go to tag definition Jump to the definition of the current word (nearthe keyboard cursor). If the definition cannot befound (e.g. the relevant file is not open) Geanywill beep and do nothing. See the section calledGo to tag definition.

Go to tag declaration Jump to the declaration of the current word (nearthe keyboard cursor). If the declaration cannotbe found (e.g. the relevant file is not open)Geany will beep and do nothing. See the sectioncalled Go to tag declaration.

Go to Start of Line Home Move the caret to the end of the line indentationunless it is already there, in which case it movesit to the start of the line.

Go to End of Line End Move the caret to the end of the line.

Go to End of Display Line Alt-End Move the caret to the end of the display line.This is useful when you use line wrapping andwant to jump to the end of the wrapped, virtualline, not the real end of the whole line. If the line

is not wrapped, it behaves like Go to End of Line,see above.

Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.

Go to Next Word Part Ctrl- Goto the next part of the current word.

View keybindings

Action Default shortcut Description

Fullscreen F11 (C) Switches to fullscreen mode.

Toggle Messages Window Toggles the message window (status andcompiler messages) on and off.

Toggle Sidebar Shows or hides the sidebar.

Toggle all additional widgets Hide and show all additional widgets like thenotebook tabs, the toolbar, the messageswindow and the status bar.

Zoom In Ctrl-+ (C) Zooms in the text.

Zoom Out Ctrl-- (C) Zooms out the text.

Zoom Reset Ctrl-0 Reset any previous zoom on the text.

Focus keybindings

Action Default shortcut Description

Switch to Editor F2 Switches to editor widget. Also reshows thedocument statistics line (after a short timeout).

Switch to Scribble F6 Switches to scribble widget.

Switch to VTE F4 Switches to VTE widget.

Switch to Search Bar F7 Switches to the search bar in the toolbar (ifvisible).

Switch to Sidebar Focus the Sidebar.

Switch to Compiler Focus the Compiler message window tab.

Switch to Messages Focus the Messages message window tab.

Switch to Message Window Focus the Message Window's current tab.

Switch to Sidebar DocumentList

Focus the Document list tab in the Sidebar (ifvisible).

Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar (ifvisible).

Notebook tab keybindings

Action Default shortcut Description

Switch to left document Ctrl-PageUp (C) Switches to the previous open document.

Switch to right document Ctrl-PageDown (C) Switches to the next open document.

Switch to last useddocument

Ctrl-Tab Switches to the previously shown document (if it'sstill open). Holding Ctrl (or another modifier if thekeybinding has been changed) will show a dialog,then repeated presses of the keybinding will switchto the 2nd-last used document, 3rd-last, etc. Alsoknown as Most-Recently-Used documentsswitching.

Move document left Alt-PageUp Changes the current document with the left handone.

Move document right Alt-PageDown Changes the current document with the right handone.

Move document first Moves the current document to the first position.

Move document last Moves the current document to the last position.

Document keybindings

Action Default shortcut Description

Replace tabs by space Replaces all tabs with the right amount of spaces.

Replace spaces by tabs Replaces all spaces with tab characters.

Toggle current fold Toggles the folding state of the current codeblock.

Fold all Folds all contractible code blocks.

Unfold all Unfolds all contracted code blocks.

Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.

Toggle Line wrapping Enables or disables wrapping of long lines.

Toggle Line breaking Enables or disables automatic breaking of longlines at a configurable column.

Remove Markers Remove any markers on lines or words whichwere set by using 'Mark All' in the search dialog orby manually marking lines.

Remove Error Indicators Remove any error indicators in the currentdocument.

Build keybindings

Action Default shortcut Description

Compile F8 Compiles the current file.

Build F9 Builds (compiles if necessary and links) thecurrent file.

Make all Shift-F9 Builds the current file with the Make tool.

Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and agiven target.

Make object Compiles the current file with the Make tool.

Next error Jumps to the line with the next error from thelast build process.

Previous error Jumps to the line with the previous error fromthe last build process.

Run F5 Executes the current file in a terminal emulation.

Set Build Commands Opens the build commands dialog.

Tools keybindings

Action Default shortcut Description

Show Color Chooser Opens the Color Chooser dialog.

Help keybindings

Action Default shortcut Description

Help F1 (C) Opens the manual.

Configuration filesWarning

You must use UTF-8 encoding without BOM for configuration files.

Tools menu items

There's a Configuration files submenu in the Tools menu that contains items for some of the available userconfiguration files. Clicking on one opens it in the editor for you to update. Geany will reload the file afteryou have saved it.

Note

Other configuration files not shown here will need to be opened manually, and will not be automaticallyreloaded when saved. (see Reload Configuration below).

There's also a Reload Configuration item which can be used if you updated one of the other configurationfiles, or modified or added template files.

Reload Configuration is also necessary to update syntax highlighting colors.

Note

Syntax highlighting colors aren't updated in open documents after saving filetypes.common as this canpossibly take a significant amount of time.

Global configuration file

There is a global configuration file for Geany which will be used for any settings not defined in the userslocal configuration file. Settings present in the local configuration file override those in the global file.

The global configuration file is read from $prefix/share/geany/geany.conf (where $prefix is the pathwhere Geany is installed, see Installation prefix) when starting Geany and an user configuration file does

not exist. It can contain any settings which are found in the usual configuration file created by Geany butdoes not have to contain all settings.

Note

This feature is mainly intended for package maintainers or system admins who want to set up Geany in amulti user environment and set some sane default values for this environment. Usually users won't needto do that.

Filetype definition files

All color definitions and other filetype specific settings are stored in the filetype definition files. Thosesettings are colors for syntax highlighting, general settings like comment characters or word delimitercharacters as well as compiler and linker settings.

Custom filetypes

At startup Geany looks for filetypes.*.conf files in the system and user filetype paths, adding anyfiletypes found with the name matching the '*' wildcard.

Custom filetypes are not as powerful as built-in filetypes, but the following have been implemented:

Recognizing and setting the filetype (after the user has manually editedfiletype_extensions.conf).

Filetype settings in the [settings] section (see Format).Using existing tag parsing (tag_parser key).Using existing syntax highlighting (lexer_filetype key).

Build commands.

Loading global tags files (namespace will be shared with tag_parser type).

System files

The system-wide configuration files can be found in $prefix/share/geany and are calledfiletypes.$ext, where $prefix is the path where Geany is installed (see Installation prefix) and $ext isthe name of the filetype. For every filetype there is a corresponding definition file. There is one exception:filetypes.common -- this file is for general settings, which are not specific to a certain filetype.

Warning

It is not recommended that users edit the system-wide files, because they will be overridden when Geany isupdated.

User files

To change the settings, copy a file from $prefix/share/geany to the subdirectory filedefs in yourconfiguration directory (usually ~/.config/geany/).

For example:

% cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/

Then you can edit the file and the changes are also available after an update of Geany because they residein your configuration directory. Alternatively, you can create a file~/.config/geany/filedefs/filetypes.X and add only these settings you want to change. All missingsettings will be read from the corresponding global definition file in $prefix/share/geany.

As well as the sections listed below, each filetype file can contain a [build-menu] section as described in[build-menu] Section.

Format

[styling] Section

In this section the colors for syntax highlighting are defined. The manual format is:

key=foreground_color;background_color;bold_flag;italic_flag

Colors have to be specified as RGB hex values prefixed by 0x. For example red is 0xff0000, blue is 0x0000ff.The values are case-insensitive, but it is a good idea to use small letters. Bold and italic are flags andshould only be "true" or "false". If their value is something other than "true" or "false", "false" is assumed.

You can omit fields to use the values from the style named "default".

E.g. key=0xff0000;;true

This makes the key style have red foreground text, default background color text and bold emphasis.

Using a named style

The second format uses a named style name to reference a style defined in filetypes.common.

key=named_stylekey2=named_style2,bold,italic

The bold and italic parts are optional, and if present are used to toggle the bold or italic flags to theopposite of the named style's flags. In contrast to style definition booleans, they are a literal ",bold,italic"and commas are used instead of semi-colons.

E.g. key=comment,italic

This makes the key style match the "comment" named style, but with italic emphasis.

To define named styles, see the filetypes.common [named_styles] Section.

[keywords] Section

This section contains keys for different keyword lists specific to the filetype. Some filetypes do not supportkeywords, so adding a new key will not work. You can only add or remove keywords to/from an existing list.

Important

The keywords list must be in one line without line ending characters.

[lexer_properties] Section

Here any special properties for the Scintilla lexer can be set in the format key.name.field=some.value.

[settings] Section

extension

This is the default file extension used when saving files, not including the period character (.). Theextension used should match one of the patterns associated with that filetype (see Filetypeextensions).

Example: extension=cxx

wordchars

These characters define word boundaries when making selections and searching using wordmatching options.

Example: (look at system filetypes.* files)

comment_open

A character or string which is used to comment code. If you want to use multiline comments, alsoset comment_close, otherwise leave it empty.

Example: comment_open=/*

comment_close

If multiline comments are used, this is the character or string to close the comment.

Example: comment_close=*/

comment_use_indent

Set this to false if a comment character or string should start at column 0 of a line. If set to true ituses any indentation of the line.

Note: Comment indentation

comment_use_indent=true would generate this if a line is commented (e.g. with Ctrl-D):

#command_example();

comment_use_indent=false would generate this if a line is commented (e.g. with Ctrl-D):

# command_example();

Note: This setting only works for single line comments (like '//', '#' or ';').

Example: comment_use_indent=true

context_action_cmd

A command which can be executed on the current word or the current selection.

Example usage: Open the API documentation for the current function call at the cursor position.

The command can be set for every filetype or if not set, a global command will be used. Thecommand itself can be specified without the full path, then it is searched in $PATH. But for securityreasons, it is recommended to specify the full path to the command. The wildcard %s will bereplaced by the current word at the cursor position or by the current selection.

Hint: for PHP files the following could be quite useful: context_action_cmd=firefox"http://www.php.net/%s"

Example: context_action_cmd=devhelp -s "%s"

tag_parserThe TagManager language name, e.g. "C".

lexer_filetypeA filetype name to setup syntax highlighting from another filetype. This must not be recursive, i.e. itshould be a filetype name that doesn't use the lexer_filetype key itself.

[build_settings] Section

As of Geany 0.19 this section is supplemented by the [build-menu] Section. Values that are set in the[build-menu] section will override those in this section.

error_regex

This is a GNU-style extended regular expression to parse a filename and line number from buildoutput. If undefined, Geany will fall back to its default error message parsing.

Only the first two matches will be read by Geany. Geany will look for a match that is purely digits, anduse this for the line number. The remaining match will be used as the filename.

Example: error_regex=(.+):([0-9]+):[0-9]+

This will parse a message such as: test.py:7:24: E202 whitespace before ']'

Build commands

If any build menu item settings have been configured in the Build Menu Commands dialog or the Build tabof the project preferences dialog then these settings are stored in the [build-menu] section and overridethe settings in this section for that item.

compiler

This item specifies the command to compile source code files. But it is also possible to use it withinterpreted languages like Perl or Python. With these filetypes you can use this option as a kind ofsyntax parser, which sends output to the compiler message window.

You should quote the filename to also support filenames with spaces. The following wildcards forfilenames are available:

%f -- complete filename without path%e -- filename without path and without extension

Example: compiler=gcc -Wall -c "%f"

linker

This item specifies the command to link the file. If the file is not already compiled, it will be compiledwhile linking. The -o option is automatically added by Geany. This item works well with GNU gcc, butmay be problematic with other compilers (esp. with the linker).

Example: linker=gcc -Wall "%f"

run_cmd

Use this item to execute your file. It has to have been built already. Use the %e wildcard to have onlythe name of the executable (i.e. without extension) or use the %f wildcard if you need the completefilename, e.g. for shell scripts.

Example: run_cmd="./%e"

Special file filetypes.common

There is a special filetype definition file called filetypes.common. This file defines some general non-filetype-specific settings.

See the Format section for how to define styles.

[named_styles] Section

Named styles declared here can be used in the [styling] section of any filetypes.* file.

For example:

In filetypes.common:

[named_styles]foo=0xc00000;0xffffff;false;truebar=foo

In filetypes.c:

[styling]comment=foo

This saves copying and pasting the whole style definition into several different files.

Note

You can define aliases for named styles, as shown with the bar entry in the above example, but they mustbe declared after the original style.

[styling] Section

default

This is the default style. It is used for styling files without a filetype set.

Example: default=0x000000;0xffffff;false;false

selection

The style for coloring selected text. The format is:

Foreground colorBackground colorUse foreground colorUse background color

The colors are only set if the 3rd or 4th argument is true. When the colors are not overridden, thedefault is a dark grey background with syntax highlighted foreground text.

Example: selection=0xc0c0c0;0x00007F;true;true

brace_good

The style for brace highlighting when a matching brace was found.

Example: brace_good=0xff0000;0xFFFFFF;true;false

brace_bad

The style for brace highlighting when no matching brace was found.

Example: brace_bad=0x0000ff;0xFFFFFF;true;false

caret

The style for coloring the caret(the blinking cursor). Only first and third argument is interpreted. Setthe third argument to true to change the caret into a block caret.

Example: caret=0x000000;0x0;false;false

caret_width

The width for the caret(the blinking cursor). Only the first argument is interpreted. The width isspecified in pixels with a maximum of three pixel. Use the width 0 to make the caret invisible.

Example: caret=1;0;false;false

current_line

The style for coloring the background of the current line. Only the second and third arguments areinterpreted. The second argument is the background color. Use the third argument to enable ordisable background highlighting for the current line (has to be true/false).

Example: current_line=0x0;0xe5e5e5;true;false

indent_guide

The style for coloring the indentation guides. Only the first and second arguments are interpreted.

Example: indent_guide=0xc0c0c0;0xffffff;false;false

white_space

The style for coloring the white space if it is shown. The first both arguments define the foregroundand background colors, the third argument sets whether to use the defined foreground color or touse the color defined by each filetype for the white space. The fourth argument defines whether touse the background color.

Example: white_space=0xc0c0c0;0xffffff;true;true

folding_style

The style of folding icons. Only first and second arguments are used.

Valid values for the first argument are:

1 -- for boxes2 -- for circles3 -- for arrows4 -- for +/-

Valid values for the second argument are:

0 -- for no lines1 -- for straight lines2 -- for curved lines

Default: folding_style=1;1;

Arrows: folding_style=3;0;

folding_horiz_line

Draw a thin horizontal line at the line where text is folded. Only first argument is used.

Valid values for the first argument are:

0 -- disable, do not draw a line1 -- draw the line above folded text2 -- draw the line below folded text

Example: folding_horiz_line=0;0;false;false

line_wrap_visuals

First argument: drawing of visual flags to indicate a line is wrapped. This is a bitmask of the values:

0 -- No visual flags1 -- Visual flag at end of subline of a wrapped line2 -- Visual flag at begin of subline of a wrapped line. Subline is indented by at least 1 to makeroom for the flag.

Second argument: wether the visual flags to indicate a line is wrapped are drawn near the border ornear the text. This is a bitmask of the values:

0 -- Visual flags drawn near border1 -- Visual flag at end of subline drawn near text2 -- Visual flag at begin of subline drawn near text

Only first and second argument is interpreted.

Example: line_wrap_visuals=3;0;false;false

line_wrap_indent

First argument: sets the size of indentation of sublines for wrapped lines in terms of the width of aspace, only used when the second argument is 0.

Second argument: wrapped sublines can be indented to the position of their first subline or onemore indent level. Possible values:

0 - Wrapped sublines aligned to left of window plus amount set by the first argument1 - Wrapped sublines are aligned to first subline indent (use the same indentation)2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation

Only first and second argument is interpreted.

Example: line_wrap_indent=0;1;false;false

translucency

Translucency for the current line (first argument) and the selection (second argument). Valuesbetween 0 and 256 are accepted.

Note for Windows 95, 98 and ME users: keep this value at 256 to disable translucency otherwiseGeany might crash.

Only the first and second argument is interpreted.

Example: translucency=256;256;false;false

marker_line

The style for a highlighted line (e.g when using Goto line or goto tag). The foreground color (firstargument) is only used when the Markers margin is enabled (see View menu).

Only the first and second argument is interpreted.

Example: marker_line=0x000000;0xffff00;false;false

marker_search

The style for a marked search results (when using "Mark" in Search dialogs). The second argumentsets the background colour for the drawn rectangle.

Only the second argument is interpreted.

Example: marker_search=0x000000;0xb8f4b8;false;false

marker_mark

The style for a marked line (e.g when using the "Toggle Marker" keybinding (Ctrl-M)). The foregroundcolor (first argument) is only used when the Markers margin is enabled (see View menu).

Only the first and second argument is interpreted.

Example: marker_mark=0x000000;0xb8f4b8;false;false

marker_translucency

Translucency for the line marker (first argument) and the search marker (second argument). Valuesbetween 0 and 256 are accepted.

Note for Windows 95, 98 and ME users: keep this value at 256 to disable translucency otherwiseGeany might crash.

Only the first and second argument is interpreted.

Example: marker_translucency=256;256;false;false

line_height

Amount of space to be drawn above and below the line's baseline. The first argument defines theamount of space to be drawn above the line, the second argument defines the amount of space tobe drawn below.

Only the first and second argument is interpreted.

Example: line_height=0;0;false;false

calltips

The style for coloring the calltips. The first two arguments define the foreground and backgroundcolors, the third and fourth arguments set whether to use the defined colors.

Example: calltips=0xc0c0c0;0xffffff;false;false

[settings] Section

whitespace_chars

Characters to treat as whitespace. These characters are ignored when moving, selecting anddeleting across word boundaries (see Scintilla keyboard commands).

This should include space (\s) and tab (\t).

Example: whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~

Filetype extensions

To change the default filetype extension used when saving a new file, see Filetype definition files.

You can override the list of file extensions that Geany uses for each filetype using thefiletype_extensions.conf file.

To override the system-wide configuration file, copy it from $prefix/share/geany to your configurationdirectory, usually ~/.config/geany/. $prefix is the path where Geany is installed (see Installationprefix).

For example:

% cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/

Then edit it and remove all the lines for filetype extensions that you do not want to override. The remaininglines can be edited after the = sign, using a semi-colon separated list of patterns which should be matchedfor that filetype.

For example, to set the filetype extensions for Make, the/home/username/.config/geany/filetype_extensions.conf file should look like:

[Extensions]Make=Makefile*;*.mk;Buildfile;

Preferences File Format

The preferences file ~/.config/geany/geany.conf holds settings for all the items configured in thepreferences dialog. This file should not be edited while Geany is running as the file will be overwritten when

the preferences in Geany are changed or Geany is quitted.

Hidden preferences

There are some rarely used preferences that are not shown in the Preferences dialog. These can be set byediting the preferences file, then restarting Geany. Search for the key name, then edit the value. Example:

brace_match_ltgt=true

The table below show the key names of hidden preferences in the configuration file.

Key Description Default

Editor related

brace_match_ltgt Whether to highlight <, > angle brackets. false

show_editor_scrollbars Whether to display scrollbars. If set to false, thehorizontal and vertical scrollbars are hiddencompletely.

true

use_gtk_word_boundaries Whether to look for the end of a word whenusing word-boundary related Scintillacommands (see Scintilla keyboard commands).

true

complete_snippets_whilst_editing Whether to allow completion of snippets whenediting an existing line (i.e. there is some textafter the current cursor position on the line).Only used when the keybinding Completesnippet is set to Space.

false

Interface related

show_symbol_list_expanders Whether to show or hide the small expandericons on the symbol list treeview (only availablewith GTK 2.12 or above).

true

allow_always_save Whether files can be saved always, even if theydon't have any changes. By default, the Savebuttons and menu items are disabled when afile is unchanged. When setting this option totrue, the Save buttons and menu items arealways active and files can be saved.

false

compiler_tab_autoscroll Whether to automatically scroll to the last line ofthe output in the Compiler tab.

true

VTE related

emulation Terminal emulation mode. Only change this ifyou have VTE termcap files other thanvte/termcap/xterm.

xterm

send_selection_unsafe By default, Geany strips any trailing newlinecharacters from the current selection beforesending it to the terminal to not executearbitrary code. This is mainly a security feature.If, for whatever reasons, you really want it to beexecuted directly, set this option to true.

false

File related

use_safe_file_saving Defines the mode how Geany saves files to disk.If disabled, Geany directly writes the content ofthe document to disk. This might cause in lossof data when there is no more free space ondisk to save the file. When set to true, Geanyfirst saves the contents into a temporary fileand if this succeeded, the temporary file ismoved to the real file to save. This gives bettererror checking in case of no more free diskspace. But it also destroys hard links of theoriginal file and its permissions (e.g. executableflags are reset). Use this with care as it canbreak things seriously. The better approachwould be to ensure your disk won't run out offree space.

false

Build Menu related

number_ft_menu_items The maximum number of menu items in thefiletype section of the Build menu.

2

number_non_ft_menu_items The maximum number of menu items in thenon-filetype section of the Build menu.

3

number_exec_menu_items The maximum number of menu items in theexecute section of the Build menu.

2

[build-menu] Section

The [build-menu] section contains the configuration of the build menu. This section can occur in filetype,preferences and project files and always has the format described here. Different menu items are loadedfrom different files, see the table in the Build Menu Configuration section for details. All the settings can beconfigured from the dialogs except the execute command in filetype files and filetype definitions in theproject file, so these are the only ones which need hand editing.

The build-menu section stores one entry for each setting for each menu item that is configured. The keysfor these settings have the format:

GG_NN_FF

where:

GG - is the menu item group,FT for filetypeNF for non-filetypeEX for execute

NN - is a two decimal digit number of the item within the group, starting at 00FF - is the field,

LB for labelCM for commandWD for working directory

Project File Format

The project file contains project related settings and possibly a record of the current session files.

[build-menu] Additions

The project file also can have extra fields in the [build-menu] section in addition to those listed in [build-menu] Section above.

When filetype menu items are configured for the project they are stored in the project file.

The filetypes entry is a list of the filetypes which exist in the project file.

For each filetype the entries for that filetype have the format defined in [build-menu] Section but the key isprefixed by the name of the filetype as it appears in the filetypes entry, eg the entry for the label offiletype menu item 0 for the C filetype would be

CFT_00_LB=Label

Templates

Geany supports the following templates:

ChangeLog entryFile headerFunction descriptionShort GPL noticeShort BSD noticeFile templates

To use these templates, just open the Edit menu or open the popup menu by right-clicking in the editorwidget, and choose "Insert Comments" and insert templates as you want.

Some templates (like File header or ChangeLog entry) will always be inserted at the top of the file.

To insert a function description, the cursor must be inside of the function, so that the function name can bedetermined automatically. The description will be positioned correctly one line above the function, justcheck it out. If the cursor is not inside of a function or the function name cannot be determined, theinserted function description won't contain the correct function name but "unknown" instead.

Note

Geany automatically reloads template information when it notices you save a file in the user's templateconfiguration directory. You can also force this by selecting Tools->Reload Configuration.

Template meta data

Meta data can be used with all templates, but by default user set meta data is only used for theChangeLog and File header templates.

In the configuration dialog you can find a tab "Templates" (see Template preferences). You can define thedefault values which will be inserted in the templates. You should select Tools->Reload Configuration orrestart Geany after making changes.

File templates

File templates are templates used as the basis of a new file. To use them, choose the New (withTemplate) menu item from the File menu.

By default, file templates are installed for some filetypes. Custom file templates can be added by creatingthe appropriate template file. You can also edit the default file templates.

The file's contents are just the text to place in the document, with optional template wildcards like{fileheader}. The fileheader wildcard can be placed anywhere, but it's usually put on the first line of thefile, followed by a blank line.

Custom file templates

These are read from the following directories:

$prefix/share/geany/templates/files (see Installation prefix)~/.config/geany/templates/files (created the first time Geany is started).

The filetype to use is detected from the template file's extension, if any. For example, creating a filemodule.c would add a menu item which created a new document with the filetype set to 'C'.

The template file is read from disk when the corresponding menu item is clicked.

Filetype templates

Note

It's recommended to use custom file templates instead.

Filetype template files are read from the ~/.config/geany/templates directory, and are named"filetype." followed by the filetype name, e.g. "filetype.python", "filetype.sh", etc. If you are unsure about thefiletype name extensions, they are the same as the filetype configuration file extensions, commonlyinstalled in /usr/share/geany, with the prefix "filetypes.".

There is also a template file filetype.none which is used when the New command is used without afiletype. This is empty by default.

Customizing templates

Each template can be customized to your needs. The templates are stored in the~/.config/geany/templates/ directory (see the section called Command line options for furtherinformation about the configuration directory). Just open the desired template with an editor (ideally, Geany;-) ) and edit the template to your needs. There are some wildcards which will be automatically replaced byGeany at startup.

Template wildcards

All wildcards must be enclosed by "{" and "}", e.g. {date}.

Wildcards for character escaping

Wildcard Description Available in

ob { Opening Brace (used to prevent otherwildcards being expanded).

file templates, file header, snippets.

cb } Closing Brace. file templates, file header, snippets.

pc % Percent (used to escape e.g. %block% insnippets).

snippets.

Global wildcards

These are configurable, see Template preferences.

Wildcard Description Available in

developer The name of the developer. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

initial The developer's initials, e.g. "ET" for EnricoTröger or "JFD" for John Foobar Doe.

file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

mail The email address of the developer. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

company The company the developer is working for. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

version The initial version of a new file. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

Date & time wildcards

The format for these wildcards can be changed in the preferences dialog, see Template preferences. You

can use any conversion specifiers which can be used with the ANSI C strftime function. For details pleasesee http://man.cx/strftime.

Wildcard Description Available in

year The current year. Default format is: YYYY. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

date The current date. Default format: YYYY-MM-DD. file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

datetime The current date and time. Default format:DD.MM.YYYY HH:mm:ss ZZZZ.

file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

Dynamic wildcards

Wildcard Description Available in

untitled The string "untitled" (this will be translated toyour locale), used in file templates.

file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

geanyversion The actual Geany version, e.g. "Geany 0.19.1". file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

filename The filename of the current file. For new files,it's only replaced when first saving if found onthe first 3 lines of the file.

file header, snippets, file templates.

project The current project's name, if any. file header, snippets, file templates.

description The current project's description, if any. file header, snippets, file templates.

functionname The function name of the function at the cursorposition. This wildcard will only be replaced inthe function description template.

function description.

command:path Executes the specified command and replacethe wildcard with the command's standardoutput. See Special {command:} wildcard fordetails.

file templates, file header, functiondescription, ChangeLog entry, bsd, gpl,snippets.

Template insertion wildcards

Wildcard Description Available in

gpl This wildcard inserts a short GPL notice. file header.

bsd This wildcard inserts a BSD licence notice. file header.

fileheader The file header template. This wildcard will onlybe replaced in filetype templates.

snippets, file templates.

Special {command:} wildcard

The {command:} wildcard is a special one because it can execute a specified command and put thecommand's output (stdout) into the template.

Example:

{command:uname -a}

will result in:

Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux

Using this wildcard you can insert nearly any arbitrary text into the template.

In the environment of the executed command the variables GEANY_FILENAME, GEANY_FILETYPE andGEANY_FUNCNAME are set. The value of these variables is filled in only if Geany knows about it. For example,GEANY_FUNCNAME is only filled within the function description template. However, these variables arealways set, just maybe with an empty value. You can easily access them e.g. within an executed shellscript using:

$GEANY_FILENAME

Note

If the specified command could not be found or not executed, the wildcard is substituted by an emptystring. In such cases, you can find the occurred error message on Geany's standard error and in the Help->Debug Messages dialog.

Customizing the toolbar

You can add, remove and reorder the elements in the toolbar by using the toolbar editor by manuallyediting the file ui_toolbar.xml.

The toolbar editor can be opened from the preferences editor on the Toolbar tab or by right-clicking on thetoolbar itself and choosing it from the menu.

Manually editing of the toolbar layout

To override the system-wide configuration file, copy it from $prefix/share/geany to your configurationdirectory, usually ~/.config/geany/. $prefix is the path where Geany is installed (see Installationprefix).

For example:

% cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/

Then edit it and add any of the available elements listed in the file or remove any of the existing elements.Of course, you can also reorder the elements as you wish and add or remove additional separators. Thisfile must be valid XML, otherwise the global toolbar UI definition will be used instead.

Your changes are applied once you save the file.

Note

1. You cannot add new actions which are not listed below.2. Everything you add or change must be inside the /ui/toolbar/ path.

Available toolbar elements

Element name Description

New Create a new file

Open Open an existing file

Save Save the current file

SaveAll Save all open files

Reload Reload the current file from disk

Close Close the current file

CloseAll Close all open files

Print Print the current file

Cut Cut the current selection

Copy Copy the current selection

Paste Paste the contents of the clipboard

Delete Delete the current selection

Undo Undo the last modification

Redo Redo the last modification

NavBack Navigate back a location

NavFor Navigate forward a location

Compile Compile the current file

Build Build the current file, includes a submenu for Make commands. Geany remembersthe last chosen action from the submenu and uses this as default action when thebutton itself is clicked.

Run Run or view the current file

Color Open a color chooser dialog, to interactively pick colors from a palette

ZoomIn Zoom in the text

ZoomOut Zoom out the text

UnIndent Decrease indentation

Indent Increase indentation

Replace Replace text in the current document

SearchEntry The search field belonging to the 'Search' element (can be used alone)

Search Find the entered text in the current file (only useful if you also use 'SearchEntry')

GotoEntry The goto field belonging to the 'Goto' element (can be used alone)

Goto Jump to the entered line number (only useful if you also use 'GotoEntry')

Preferences Show the preferences dialog

Quit Quit Geany

Plugin documentation

Save Actions

Instant Save

This plugin sets on every new file (File->New or File-> New (with template)) a randomly chosen filenameand set its filetype appropriate to the used template or when no template was used, to a configurabledefault filetype. This enables you to quickly compile, build and/or run the new file without the need to give itan explicit filename using the Save As dialog. This might be useful when you often create new files just fortesting some code or something similar.

Backup Copy

This plugin creates a backup copy of the current file in Geany when it is saved. You can specify the directorywhere the backup copy is saved and you can configure the automatically added extension in the configuredialog in Geany's plugin manager.

After the plugin was loaded in Geany's plugin manager, every file is copied into the configured backupdirectory when the file is saved in Geany.

Contributing to this documentThis document (geany.txt) is written in reStructuredText (or "reST"). The source file for it is located inGeany's doc subdirectory. If you intend on making changes, you should grab the source right from SVN tomake sure you've got the newest version. After editing the file, to build the HTML document to see howyour changes look, run "make doc" in the subdirectory doc of Geany's source directory. This regeneratesthe geany.html file. To generate a PDF file, use the command "make pdf" which should generate a filecalled geany-0.19.1.pdf.

After you are happy with your changes, create a patch:

% svn diff geany.txt > foo.patch

and then submit that file to the mailing list for review.

Note, you will need the Python docutils software package installed to build the docs. The package is namedpython-docutils on Debian and Fedora systems.

Scintilla keyboard commandsCopyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>

This appendix is distributed under the terms of the License for Scintilla and SciTE. A copy of this license canbe found in the file scintilla/License.txt included with the source code of this program and in theappendix of this document. See License for Scintilla and SciTE.

20 June 2006

Keyboard commands

Keyboard commands for Scintilla mostly follow common Windows and GTK+ conventions. All move keys(arrows, page up/down, home and end) allows to extend or reduce the stream selection when holding theShift key, and the rectangular selection when holding the Shift and Ctrl keys. Some keys may not beavailable with some national keyboards or because they are taken by the system such as by a windowmanager or GTK. Keyboard equivalents of menu commands are listed in the menus. Some less commoncommands with no menu equivalent are:

Action Shortcut key

Magnify text size. Ctrl+Keypad+

Reduce text size. Ctrl+Keypad-

Restore text size to normal. Ctrl+Keypad/

Indent block. Tab

Dedent block. Shift+Tab

Delete to start of word. Ctrl+BackSpace

Delete to end of word. Ctrl+Delete

Delete to start of line. Ctrl+Shift+BackSpace

Go to start of document. Ctrl+Home

Extend selection to start of document. Ctrl+Shift+Home

Go to start of display line. Alt+Home

Extend selection to start of display line. Alt+Shift+Home

Go to end of document. Ctrl+End

Extend selection to end of document. Ctrl+Shift+End

Extend selection to end of display line. Alt+Shift+End

Previous paragraph. Shift extends selection. Ctrl+Up

Next paragraph. Shift extends selection. Ctrl+Down

Previous word. Shift extends selection. Ctrl+Left

Next word. Shift extends selection. Ctrl+Right

Tips and tricks

Document notebook

Double-click on empty space in the notebook tab bar to open a new document.Middle-click on a document's notebook tab to close the document.Hold Ctrl and click on any notebook tab to switch to the last used document.Double-click on a document's notebook tab to toggle all additional widgets (to show them again usethe View menu or the keyboard shortcut). The interface pref must be enabled for this to work.

Editor

Alt-scroll wheel moves up/down a page.Ctrl-scroll wheel zooms in/out.Shift-scroll wheel scrolls 8 characters right/left.Ctrl-click on a word in a document to perform Go to Tag Definition.Ctrl-click on a bracket/brace to perform Go to Matching Brace.

Interface

Double-click on a symbol-list group to expand or compact it.

GTK-related

Scrolling the mouse wheel over a notebook tab bar will switch notebook pages.

The following are derived from X-Windows features (but GTK still supports them on Windows):

Middle-click pastes the last selected text.Middle-click on a scrollbar moves the scrollbar to that position without having to drag it.

Compile-time optionsThere are some options which can only be changed at compile time, and some options which are used asthe default for configurable options. To change these options, edit the appropriate source file in the srcsubdirectory. Look for a block of lines starting with #define GEANY_*. Any definitions which are not listedhere should not be changed.

Note

Most users should not need to change these options.

src/geany.h

Option Description Default

GEANY_STRING_UNTITLED A string used as the default name for new files.Be aware that the string can be translated, sochange it only if you know what you are doing.

untitled

GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620

GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440

GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the firststart.

900

GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the firststart.

600

Windows specific

GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the defaultWindows file open and save dialogs instead GTK'sfile open and save dialogs. The default Windowsfile dialogs are missing some nice features likechoosing a filetype or an encoding. Do not touchthis setting when building on a non-Win32system.

0

project.h

Option Description Default

GEANY_PROJECT_EXT The default filename extension for Geany projectfiles. It is used when creating new projects and as

geany

filter mask for the project open dialog.

editor.h

Option Description Default

GEANY_WORDCHARS These characters define word boundaries whenmaking selections and searching using wordmatching options.

a string with: a-z,A-Z, 0-9 andunderscore.

keyfile.c

These are default settings that can be overridden in the Preferences dialog.

Option Description Default

GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type totrigger the autocompletion list.

4

GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file forexternal changes.

30

GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"

GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept thecommand line option "-e". This can alsoinclude a path.

"xterm"

GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"

GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept andprocess plain text files. This can also include apath.

"lpr"

GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with GNUgrep. This can also include a path.

"grep"

GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10

GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols andopen files.

"Sans 9"

GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"

GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"

GEANY_TOGGLE_MARK A string which is used to mark a toggledcomment.

"~ "

GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestionsshould Geany provide.

30

build.c

Option Description Default

GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to be shown inthe editor window. This affects the specialcoloring when Geany detects a compiler outputline as an error message and then highlightsthe corresponding line in the source code.Usually only the first few messages areinteresting because following errors are justafter-effects. All errors in the Compiler windoware parsed and unaffected by this value.

50

PRINTBUILDCMDS Every time a build menu item priority calculationis run, print the state of the menu item table inthe form of the table in Build MenuConfiguration. May be useful to debugconfiguration file overloading. Warning producesa lot of output. Can also be enabled/disabled bythe debugger by setting printbuildcmds to 1/0overriding the compile setting.

FALSE

GNU General Public License GNU GENERAL PUBLIC LICENSE Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

The licenses for most software are designed to take away yourfreedom to share and change it. By contrast, the GNU General PublicLicense is intended to guarantee your freedom to share and change freesoftware--to make sure the software is free for all its users. ThisGeneral Public License applies to most of the Free SoftwareFoundation's software and to any other program whose authors commit tousing it. (Some other Free Software Foundation software is covered bythe GNU Library General Public License instead.) You can apply it toyour programs, too.

When we speak of free software, we are referring to freedom, notprice. Our General Public Licenses are designed to make sure that youhave the freedom to distribute copies of free software (and charge forthis service if you wish), that you receive source code or can get itif you want it, that you can change the software or use pieces of itin new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbidanyone to deny you these rights or to ask you to surrender the rights.These restrictions translate to certain responsibilities for you if youdistribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whethergratis or for a fee, you must give the recipients all the rights thatyou have. You must make sure that they, too, receive or can get thesource code. And you must show them these terms so they know theirrights.

We protect your rights with two steps: (1) copyright the software, and(2) offer you this license which gives you legal permission to copy,distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certainthat everyone understands that there is no warranty for this freesoftware. If the software is modified by someone else and passed on, wewant its recipients to know that what they have is not the original, sothat any problems introduced by others will not reflect on the originalauthors' reputations.

Finally, any free program is threatened constantly by softwarepatents. We wish to avoid the danger that redistributors of a freeprogram will individually obtain patent licenses, in effect making theprogram proprietary. To prevent this, we have made it clear that anypatent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution andmodification follow.

GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which containsa notice placed by the copyright holder saying it may be distributedunder the terms of this General Public License. The "Program", below,refers to any such program or work, and a "work based on the Program"means either the Program or any derivative work under copyright law:that is to say, a work containing the Program or a portion of it,either verbatim or with modifications and/or translated into anotherlanguage. (Hereinafter, translation is included without limitation inthe term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are notcovered by this License; they are outside its scope. The act ofrunning the Program is not restricted, and the output from the Programis covered only if its contents constitute a work based on theProgram (independent of having been made by running the Program).Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program'ssource code as you receive it, in any medium, provided that youconspicuously and appropriately publish on each copy an appropriatecopyright notice and disclaimer of warranty; keep intact all thenotices that refer to this License and to the absence of any warranty;and give any other recipients of the Program a copy of this Licensealong with the Program.

You may charge a fee for the physical act of transferring a copy, and

you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portionof it, thus forming a work based on the Program, and copy anddistribute such modifications or work under the terms of Section 1above, provided that you also meet all of these conditions:

a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. Ifidentifiable sections of that work are not derived from the Program,and can be reasonably considered independent and separate works inthemselves, then this License, and its terms, do not apply to thosesections when you distribute them as separate works. But when youdistribute the same sections as part of a whole which is a work basedon the Program, the distribution of the whole must be on the terms ofthis License, whose permissions for other licensees extend to theentire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contestyour rights to work written entirely by you; rather, the intent is toexercise the right to control the distribution of derivative orcollective works based on the Program.

In addition, mere aggregation of another work not based on the Programwith the Program (or with a work based on the Program) on a volume ofa storage or distribution medium does not bring the other work underthe scope of this License.

3. You may copy and distribute the Program (or a work based on it,under Section 2) in object code or executable form under the terms ofSections 1 and 2 above provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work formaking modifications to it. For an executable work, complete sourcecode means all the source code for all modules it contains, plus anyassociated interface definition files, plus the scripts used tocontrol compilation and installation of the executable. However, as aspecial exception, the source code distributed need not includeanything that is normally distributed (in either source or binaryform) with the major components (compiler, kernel, and so on) of theoperating system on which the executable runs, unless that componentitself accompanies the executable.

If distribution of executable or object code is made by offering

access to copy from a designated place, then offering equivalentaccess to copy the source code from the same place counts asdistribution of the source code, even though third parties are notcompelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Programexcept as expressly provided under this License. Any attemptotherwise to copy, modify, sublicense or distribute the Program isvoid, and will automatically terminate your rights under this License.However, parties who have received copies, or rights, from you underthis License will not have their licenses terminated so long as suchparties remain in full compliance.

5. You are not required to accept this License, since you have notsigned it. However, nothing else grants you permission to modify ordistribute the Program or its derivative works. These actions areprohibited by law if you do not accept this License. Therefore, bymodifying or distributing the Program (or any work based on theProgram), you indicate your acceptance of this License to do so, andall its terms and conditions for copying, distributing or modifyingthe Program or works based on it.

6. Each time you redistribute the Program (or any work based on theProgram), the recipient automatically receives a license from theoriginal licensor to copy, distribute or modify the Program subject tothese terms and conditions. You may not impose any furtherrestrictions on the recipients' exercise of the rights granted herein.You are not responsible for enforcing compliance by third parties tothis License.

7. If, as a consequence of a court judgment or allegation of patentinfringement or for any other reason (not limited to patent issues),conditions are imposed on you (whether by court order, agreement orotherwise) that contradict the conditions of this License, they do notexcuse you from the conditions of this License. If you cannotdistribute so as to satisfy simultaneously your obligations under thisLicense and any other pertinent obligations, then as a consequence youmay not distribute the Program at all. For example, if a patentlicense would not permit royalty-free redistribution of the Program byall those who receive copies directly or indirectly through you, thenthe only way you could satisfy both it and this License would be torefrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable underany particular circumstance, the balance of the section is intended toapply and the section as a whole is intended to apply in othercircumstances.

It is not the purpose of this section to induce you to infringe anypatents or other property right claims or to contest validity of anysuch claims; this section has the sole purpose of protecting theintegrity of the free software distribution system, which isimplemented by public license practices. Many people have madegenerous contributions to the wide range of software distributedthrough that system in reliance on consistent application of thatsystem; it is up to the author/donor to decide if he or she is willingto distribute software through any other system and a licensee cannotimpose that choice.

This section is intended to make thoroughly clear what is believed tobe a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted incertain countries either by patents or by copyrighted interfaces, theoriginal copyright holder who places the Program under this Licensemay add an explicit geographical distribution limitation excludingthose countries, so that distribution is permitted only in or amongcountries not thus excluded. In such case, this License incorporatesthe limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versionsof the General Public License from time to time. Such new versions willbe similar in spirit to the present version, but may differ in detail toaddress new problems or concerns.

Each version is given a distinguishing version number. If the Programspecifies a version number of this License which applies to it and "anylater version", you have the option of following the terms and conditionseither of that version or of any later version published by the Free

Software Foundation. If the Program does not specify a version number ofthis License, you may choose any version ever published by the Free SoftwareFoundation.

10. If you wish to incorporate parts of the Program into other freeprograms whose distribution conditions are different, write to the authorto ask for permission. For software which is copyrighted by the FreeSoftware Foundation, write to the Free Software Foundation; we sometimesmake exceptions for this. Our decision will be guided by the two goalsof preserving the free status of all derivatives of our free software andof promoting the sharing and reuse of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTYFOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHENOTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIESPROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSEDOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK ASTO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THEPROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITINGWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/ORREDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISINGOUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITEDTO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BYYOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHERPROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatestpossible use to the public, the best way to achieve this is to make itfree software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safestto attach them to the start of each source file to most effectivelyconvey the exclusion of warranty; and each file should have at leastthe "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like thiswhen it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriateparts of the General Public License. Of course, the commands you use maybe called something other than `show w' and `show c'; they could even bemouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or yourschool, if any, to sign a "copyright disclaimer" for the program, ifnecessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program intoproprietary programs. If your program is a subroutine library, you mayconsider it more useful to permit linking proprietary applications with thelibrary. If this is what you want to do, use the GNU Library GeneralPublic License instead of this License.

License for Scintilla and SciTECopyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>

All Rights Reserved

Permission to use, copy, modify, and distribute this software and its documentation for any purpose andwithout fee is hereby granted, provided that the above copyright notice appear in all copies and that boththat copyright notice and this permission notice appear in supporting documentation.

NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANYSPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROMLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHERTORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THISSOFTWARE.

View document source. Generated on: 2010-08-13 14:20 UTC. Generated by Docutils fromreStructuredText source.