geany.txt 66.9 KB
Newer Older
Enrico Tröger's avatar
Enrico Tröger committed
1

Enrico Tröger's avatar
Enrico Tröger committed
2
Geany 0.9
Enrico Tröger's avatar
Enrico Tröger committed
3

Enrico Tröger's avatar
Enrico Tröger committed
4
Enrico Tröger
Enrico Tröger's avatar
Enrico Tröger committed
5

Enrico Tröger's avatar
Enrico Tröger committed
6
Nick Treleaven
Enrico Tröger's avatar
Enrico Tröger committed
7

Enrico Tröger's avatar
Enrico Tröger committed
8 9 10 11 12 13 14 15 16
Frank Lanitz

   Copyright © 2005-2006

   This document is distributed 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. A copy of this license can be found
   in the file COPYING included with the source code of this
Enrico Tröger's avatar
Enrico Tröger committed
17
   program and see Appendix B.
Enrico Tröger's avatar
Enrico Tröger committed
18 19 20 21 22
     _________________________________________________________

   Table of Contents
   1. Introduction

Enrico Tröger's avatar
Enrico Tröger committed
23 24
        1.1. About Geany
        1.2. About this document
Enrico Tröger's avatar
Enrico Tröger committed
25
        1.3. Where to get it
Enrico Tröger's avatar
Enrico Tröger committed
26
        1.4. License
Enrico Tröger's avatar
Enrico Tröger committed
27 28 29 30

   2. Installation

        2.1. Requirements
Enrico Tröger's avatar
Enrico Tröger committed
31 32
        2.2. Source compilation
        2.3. Binary packages
Enrico Tröger's avatar
Enrico Tröger committed
33 34 35 36

              2.3.1. Fedora
              2.3.2. Debian
              2.3.3. SuSE
Enrico Tröger's avatar
Enrico Tröger committed
37
              2.3.4. Gentoo
Enrico Tröger's avatar
Enrico Tröger committed
38 39 40

   3. Usage

Enrico Tröger's avatar
Enrico Tröger committed
41
        3.1. Getting started
Enrico Tröger's avatar
Enrico Tröger committed
42
        3.2. Command line options
Enrico Tröger's avatar
Enrico Tröger committed
43
        3.3. General
Enrico Tröger's avatar
Enrico Tröger committed
44 45

              3.3.1. Startup
Enrico Tröger's avatar
Enrico Tröger committed
46 47 48
              3.3.2. Opening files from the command-line in a
                      running instance

Enrico Tröger's avatar
Enrico Tröger committed
49
              3.3.3. Virtual terminal emulator widget (VTE)
Enrico Tröger's avatar
Enrico Tröger committed
50

Enrico Tröger's avatar
Enrico Tröger committed
51 52
        3.4. Character sets and Unicode Byte-Order-Mark (BOM)
        3.5. Search, replace and go to
Enrico Tröger's avatar
Enrico Tröger committed
53

Enrico Tröger's avatar
Enrico Tröger committed
54 55 56 57 58 59 60 61
              3.5.1. Find
              3.5.2. Find usage
              3.5.3. Find in files
              3.5.4. Replace
              3.5.5. Go to tag definition
              3.5.6. Go to tag declaration
              3.5.7. Go to line
              3.5.8. Regular expressions
Enrico Tröger's avatar
Enrico Tröger committed
62

Enrico Tröger's avatar
Enrico Tröger committed
63
        3.6. Preferences
Enrico Tröger's avatar
Enrico Tröger committed
64

Enrico Tröger's avatar
Enrico Tröger committed
65
              3.6.1. Compile time options
Enrico Tröger's avatar
Enrico Tröger committed
66

Enrico Tröger's avatar
Enrico Tröger committed
67
        3.7. Build system
Enrico Tröger's avatar
Enrico Tröger committed
68

Enrico Tröger's avatar
Enrico Tröger committed
69 70 71 72 73 74 75 76 77
              3.7.1. Compile
              3.7.2. Build
              3.7.3. Make all
              3.7.4. Make custom target
              3.7.5. Make object
              3.7.6. Execute
              3.7.7. Set Includes and Arguments
              3.7.8. Indicators
              3.7.9. File type configuration settings
Enrico Tröger's avatar
Enrico Tröger committed
78

Enrico Tröger's avatar
Enrico Tröger committed
79 80
        3.8. Printing support
        3.9. Keybindings
Enrico Tröger's avatar
Enrico Tröger committed
81

Enrico Tröger's avatar
Enrico Tröger committed
82
   4. Configuration files
Enrico Tröger's avatar
Enrico Tröger committed
83

Enrico Tröger's avatar
Enrico Tröger committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
        4.1. Filetype definition files

              4.1.1. Format
              4.1.2. Special file filetypes.common

        4.2. Filetype extensions
        4.3. Templates

   A. Scintilla keyboard commands

        A.1. Keyboard commands

   B. GNU General Public License

        B.1. Preamble
        B.2. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
100
                MODIFICATION
Enrico Tröger's avatar
Enrico Tröger committed
101

Enrico Tröger's avatar
Enrico Tröger committed
102 103 104 105 106 107 108 109 110 111 112 113 114
              B.2.1. Section 0
              B.2.2. Section 1
              B.2.3. Section 2
              B.2.4. Section 3
              B.2.5. Section 4
              B.2.6. Section 5
              B.2.7. Section 6
              B.2.8. Section 7
              B.2.9. Section 8
              B.2.10. Section 9
              B.2.11. Section 10
              B.2.12. Section 11 NO WARRANTY
              B.2.13. Section 12
Enrico Tröger's avatar
Enrico Tröger committed
115

Enrico Tröger's avatar
Enrico Tröger committed
116
        B.3. How to Apply These Terms to Your New Programs
Enrico Tröger's avatar
Enrico Tröger committed
117

Enrico Tröger's avatar
Enrico Tröger committed
118
   C. License for Scintilla and SciTE
Enrico Tröger's avatar
Enrico Tröger committed
119 120

   List of Tables
Enrico Tröger's avatar
Enrico Tröger committed
121
   3-1. Command line Options
Enrico Tröger's avatar
Enrico Tröger committed
122
   3-2. Regular expressions
Enrico Tröger's avatar
Enrico Tröger committed
123
   3-3. Compile time options
Enrico Tröger's avatar
Enrico Tröger committed
124
   3-4. Keybindings action table
Enrico Tröger's avatar
Enrico Tröger committed
125 126 127 128 129
   4-1. General settings
   4-2. Build settings
   4-3. General settings
   4-4. Template wildcards
   A-1. Scintilla keyboard commands
Enrico Tröger's avatar
Enrico Tröger committed
130 131

   List of Figures
Enrico Tröger's avatar
Enrico Tröger committed
132
   3-1. Find dialog
Enrico Tröger's avatar
Enrico Tröger committed
133
   3-2. General tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
134 135 136 137 138 139 140
   3-3. Interface tab in preferences dialog
   3-4. Toolbar tab in preferences dialog
   3-5. Editor tab in preferences dialog
   3-6. Tools tab in preferences dialog
   3-7. Template tab in preferences dialog
   3-8. Keybinding tab in preferences dialog
   3-9. VTE tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
141 142

   List of Examples
Enrico Tröger's avatar
Enrico Tröger committed
143
   4-1. Comment indentation
Enrico Tröger's avatar
Enrico Tröger committed
144 145 146 147
     _________________________________________________________

Chapter 1. Introduction

Enrico Tröger's avatar
Enrico Tröger committed
148
1.1. About Geany
Enrico Tröger's avatar
Enrico Tröger committed
149

Enrico Tröger's avatar
Enrico Tröger committed
150 151
   Geany is a small and lightweight Integrated Development
   Environment. It was developed to provide a small and fast IDE,
Enrico Tröger's avatar
Enrico Tröger committed
152 153
   which has only a few dependencies from other packages. Another
   goal was to be as independent as possible from a special
Enrico Tröger's avatar
Enrico Tröger committed
154 155 156
   Desktop Environment like KDE or GNOME, so Geany only requires
   the GTK2 toolkit and therefore you only need the GTK2 runtime
   libraries installed to run it.
Enrico Tröger's avatar
Enrico Tröger committed
157 158 159

   The basic features of Geany are:

Enrico Tröger's avatar
Enrico Tröger committed
160 161 162
     * Syntax highlighting
     * Code completion
     * Auto completion of often used constructs like if, for and
Enrico Tröger's avatar
Enrico Tröger committed
163
       while
Enrico Tröger's avatar
Enrico Tröger committed
164 165 166
     * Auto completion of XML and HTML tags
     * Call tips
     * Many supported filetypes like C, Java, PHP, HTML, Python,
Enrico Tröger's avatar
Enrico Tröger committed
167
       Perl, Pascal
Enrico Tröger's avatar
Enrico Tröger committed
168
     * Tag/Symbol lists
Enrico Tröger's avatar
Enrico Tröger committed
169 170
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
171 172 173 174 175 176 177
1.2. About this document

   This documentation is available in various formats like HTML,
   text and PDF. The latest version is always available at
   http://geany.uvena.de.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
178
1.3. Where to get it
Enrico Tröger's avatar
Enrico Tröger committed
179

Enrico Tröger's avatar
Enrico Tröger committed
180
   You can obtain Geany from http://geany.uvena.de or perhaps
Enrico Tröger's avatar
Enrico Tröger committed
181 182 183
   from your distributor.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
184
1.4. License
Enrico Tröger's avatar
Enrico Tröger committed
185

Enrico Tröger's avatar
Enrico Tröger committed
186 187 188 189
   Geany is distributed 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. A copy of this license can be found in the file
Enrico Tröger's avatar
Enrico Tröger committed
190 191
   COPYING included with the source code of this program or see
   Appendix B.
192 193 194

   The included Scintilla library (found in the subdirectory
   scintilla/) has its own license, which can be found in the
Enrico Tröger's avatar
Enrico Tröger committed
195
   appendix (see Appendix C).
Enrico Tröger's avatar
Enrico Tröger committed
196 197 198 199 200 201 202 203 204 205 206
     _________________________________________________________

Chapter 2. Installation

2.1. Requirements

   For compiling Geany yourself, you will need the GTK (>= 2.6.0)
   libraries and header files. You will also need the Pango, Glib
   and ATK libraries and header files. All these files are
   available at http://www.gtk.org.

Enrico Tröger's avatar
Enrico Tröger committed
207 208 209 210
   Furthermore you need, of course, a C compiler and the Make
   tool; a C++ compiler is also required for the included
   Scintilla library. The GNU versions of these tools are
   recommended.
Enrico Tröger's avatar
Enrico Tröger committed
211 212
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
213
2.2. Source compilation
Enrico Tröger's avatar
Enrico Tröger committed
214 215 216 217 218 219 220 221 222 223

   Compiling Geany is quite easy. The following should do it:
                                        % ./configure
                                        % make
                                        % make install

   The configure script supports several common options, for a
   detailed list, type
                                        % ./configure --help

Enrico Tröger's avatar
Enrico Tröger committed
224
   In the case that your system lacks dynamic linking loader
Enrico Tröger's avatar
Enrico Tröger committed
225 226 227 228 229 230 231
   support, you probably want to pass the option --disable-vte to
   the configure script. This prevents compiling Geany with
   dynamic linking loader support to automatically load
   libvte.so.4 if available.

   Geany has been successfully compiled and tested under Debian
   3.1 Sarge, Debian 3.2 Etch, Fedora Core 4, LinuxFromScratch
Enrico Tröger's avatar
Enrico Tröger committed
232
   and FreeBSD 6.0. It also compiles under Microsoft Windows(TM),
Enrico Tröger's avatar
Enrico Tröger committed
233 234
   but there are lots of changes to the makefiles necessary.

Enrico Tröger's avatar
Enrico Tröger committed
235 236 237 238 239
   If there are any errors during compilation, check your build
   environment and try to find the error, otherwise contact the
   author at <enrico.troeger@uvena.de>.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
240
2.3. Binary packages
Enrico Tröger's avatar
Enrico Tröger committed
241 242 243

2.3.1. Fedora

Enrico Tröger's avatar
Enrico Tröger committed
244 245
   You can use the Fedora Core 4 repository from
   http://naturidentisch.de/packages/fc4/.
Enrico Tröger's avatar
Enrico Tröger committed
246 247 248

   You can also use the Fedora Core 5 repository from
   http://naturidentisch.de/packages/fc5/.
Enrico Tröger's avatar
Enrico Tröger committed
249 250 251 252
     _________________________________________________________

2.3.2. Debian

Enrico Tröger's avatar
Enrico Tröger committed
253
   Geany is available through the official Debian archives.
Enrico Tröger's avatar
Enrico Tröger committed
254

Enrico Tröger's avatar
Enrico Tröger committed
255
   apt-get install geany
Enrico Tröger's avatar
Enrico Tröger committed
256 257 258 259
     _________________________________________________________

2.3.3. SuSE

Enrico Tröger's avatar
Enrico Tröger committed
260
   Packages for SuSE are not yet available.
Enrico Tröger's avatar
Enrico Tröger committed
261 262
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
263 264
2.3.4. Gentoo

Enrico Tröger's avatar
Enrico Tröger committed
265
   An ebuild for Gentoo can be found on http://bugs.gentoo.de.
Enrico Tröger's avatar
Enrico Tröger committed
266 267
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
268 269
Chapter 3. Usage

Enrico Tröger's avatar
Enrico Tröger committed
270
3.1. Getting started
Enrico Tröger's avatar
Enrico Tröger committed
271 272 273 274 275 276 277 278 279 280 281 282

   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
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
283
3.2. Command line options
Enrico Tröger's avatar
Enrico Tröger committed
284

Enrico Tröger's avatar
Enrico Tröger committed
285
   Table 3-1. Command line Options
Enrico Tröger's avatar
Enrico Tröger committed
286
   Short option Long option Function
Enrico Tröger's avatar
Enrico Tröger committed
287
   -s --no-session Don't load the previous session's files.
Enrico Tröger's avatar
Enrico Tröger committed
288
   -n --no-ctags Do not load auto completion and call tip data.
Enrico Tröger's avatar
Enrico Tröger committed
289
   Use this option if you do not want to use them.
Enrico Tröger's avatar
Enrico Tröger committed
290 291
   -m --no-msgwin Do not show the message window. Use this option
   if you do not need compiler messages or VTE support.
Enrico Tröger's avatar
Enrico Tröger committed
292 293
   -i --new-instance Do not open files in a running instance,
   force opening a new instance.
Enrico Tröger's avatar
Enrico Tröger committed
294 295 296 297
   -t --no-terminal Do not load terminal support. Use this option
   if you do not want to load the virtual terminal emulator
   widget at startup. If you do not have libvte.so.4 installed,
   then terminal-support is automatically disabled.
Enrico Tröger's avatar
Enrico Tröger committed
298 299
   -l --vte-lib Specify explicitly the path including filename or
   only the filename to the VTE library, e.g. /usr/lib/libvte.so
Enrico Tröger's avatar
Enrico Tröger committed
300
   or libvte.so. This option is only needed when the
Enrico Tröger's avatar
Enrico Tröger committed
301
   autodetection does not work.
Enrico Tröger's avatar
Enrico Tröger committed
302 303
   -c directory_name --config=directory_name Use an alternate
   configuration directory. Default configuration directory is
Enrico Tröger's avatar
Enrico Tröger committed
304
   ~/.geany/ and there resides geany.conf and other configuration
Enrico Tröger's avatar
Enrico Tröger committed
305
   files.
Enrico Tröger's avatar
Enrico Tröger committed
306
   -d --debug Run Geany in debug mode, which means being verbose
Enrico Tröger's avatar
Enrico Tröger committed
307 308 309
   and printing lots of information.
   -? --help Show help information and exit.
   -v --version Show version information and exit.
Enrico Tröger's avatar
Enrico Tröger committed
310
     [files ...] Open all given files at startup. This option
Enrico Tröger's avatar
Enrico Tröger committed
311 312 313 314 315 316 317 318
   causes Geany to ignore loading stored files from the last
   session (if enabled).
   Geany supports all generic GTK options, a list is available on
   the help screen.
     _________________________________________________________

3.3. General

Enrico Tröger's avatar
Enrico Tröger committed
319 320
3.3.1. Startup

Enrico Tröger's avatar
Enrico Tröger committed
321
   At startup, Geany loads the first 15 files from the last time
Enrico Tröger's avatar
Enrico Tröger committed
322
   Geany was launched. You can disable this feature in the
Enrico Tröger's avatar
Enrico Tröger committed
323
   preferences dialog(see Figure 3-2). If you specify some files
Enrico Tröger's avatar
Enrico Tröger committed
324 325 326 327 328 329
   on the command line, only these files will be opened, but you
   can find the files from the last session in the file menu
   under the "Recent files" item. This contains the last 15
   recently opened files. It may be that Geany loads not exactly
   15 session files, this depends on the compile time option
   GEANY_SESSION_FILES; the default is 15. For details see
Enrico Tröger's avatar
Enrico Tröger committed
330
   Section 3.6.1.
Enrico Tröger's avatar
Enrico Tröger committed
331 332 333 334 335 336

   You can start several instances of Geany, but only the first
   will load files from the last session. To run a second
   instance of Geany, do not specify any filenames on the
   command-line, or disable opening files in a running instance
   using the appropriate command line option.
Enrico Tröger's avatar
Enrico Tröger committed
337 338
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
339
3.3.2. Opening files from the command-line in a running instance
Enrico Tröger's avatar
Enrico Tröger committed
340

Enrico Tröger's avatar
Enrico Tröger committed
341
   Geany detects an already running instance of itself and opens
Enrico Tröger's avatar
Enrico Tröger committed
342 343 344 345 346 347
   files from the command-line in the already running instance.
   So, Geany can be used to view and edit files by opening them
   from other programs such as a file manager. If you do not like
   this for some reason, you can disable using the first instance
   by using the appropriate command line option - see Section
   3.2.
Enrico Tröger's avatar
Enrico Tröger committed
348 349
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
350
3.3.3. Virtual terminal emulator widget (VTE)
Enrico Tröger's avatar
Enrico Tröger committed
351 352

   If you have installed libvte.so in your system, it is loaded
Enrico Tröger's avatar
Enrico Tröger committed
353 354
   automatically by Geany, and you will have a terminal widget in
   the notebook at the bottom.
Enrico Tröger's avatar
Enrico Tröger committed
355 356 357 358

   If Geany cannot find libvte.so at startup, the terminal widget
   will not be loaded. So there is no need to install the package
   containing this file in order to run Geany. Additionally, you
Enrico Tröger's avatar
Enrico Tröger committed
359
   can disable the use of the terminal widget by command line
Enrico Tröger's avatar
Enrico Tröger committed
360 361 362
   option, for more information see Section 3.2.

   You can use this terminal (from now on called VTE) nearly as
Enrico Tröger's avatar
Enrico Tröger committed
363 364 365 366 367 368 369 370 371 372
   an usual terminal program like xterm. There is basic clipboard
   support. You can paste the contents of the clipboard by
   pressing the right mouse button to open the popup menu and
   choosing Paste. To copy text from the VTE, just select the
   desired text and then press the right mouse button and choose
   Copy from the popup menu. On systems running the 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).
Enrico Tröger's avatar
Enrico Tröger committed
373 374 375 376 377

   Note

   Geany tries to load libvte.so. If this fails, it tries to load
   libvte.so.4. If this fails too, you should check whether you
Enrico Tröger's avatar
Enrico Tröger committed
378 379 380 381 382 383
   installed libvte correctly. Again, Geany also runs without
   this library.

   It could be, that the library is called something else than
   libvte.so.4 (e.g. on FreeBSD 6.0 it is called libvte.so.8). So
   please set a link to the correct file (as root).
Enrico Tröger's avatar
Enrico Tröger committed
384 385 386 387 388 389
# ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so.4

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

Enrico Tröger's avatar
Enrico Tröger committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
3.4. Character sets and Unicode Byte-Order-Mark (BOM)

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

   Furthermore, Geany detects an Unicode Byte Order Mark (see
   http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of
   course, this feature is only available if the opened file is
   in an unicode encoding. The Byte Order Mark helps to detect
   the encoding of a file, e.g. whether it is UTF-16LE or
   UTF-16BE and so on. On Unix-like systems using a Byte Order
   Mark could cause some problems, e.g. the gcc stops with stray
   errors, PHP does not parse a script containing a BOM and
   script files starting with a she-bang maybe cannot be started.
   In the status bar you can easily see whether the file starts
   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
   and toggle the checkbox.

   Note

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

3.5. Search, replace and go to

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

     * Find
     * Find usage *
     * Find in files
     * Replace
     * Go 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 (see Section 3.9).
     _________________________________________________________
Enrico Tröger's avatar
Enrico Tröger committed
435

Enrico Tröger's avatar
Enrico Tröger committed
436
3.5.1. Find
Enrico Tröger's avatar
Enrico Tröger committed
437

Enrico Tröger's avatar
Enrico Tröger committed
438 439 440 441 442
   The Find dialog is used for finding text within the current
   document. The syntax for the "Use regular expressions" option
   is shown in Table 3-2.

   Figure 3-1. Find dialog
Enrico Tröger's avatar
Enrico Tröger committed
443 444

   [find_dialog.jpg]
Enrico Tröger's avatar
Enrico Tröger committed
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
     _________________________________________________________

3.5.2. Find usage

   Find usage searches all open files. If there is a selection,
   then it is used as the search text; otherwise the current word
   is used. The current word is either taken from the word
   nearest the edit cursor, or the word underneath the popup menu
   click position when the popup menu is used. The search results
   are shown in the Messages window.
     _________________________________________________________

3.5.3. Find in files

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

3.5.4. Replace

   The Replace dialog has the same options for finding text as
   the Find dialog. There is also a "Replace in all files"
   option, which is used with the Replace All button to perform
   the replacement for all open files.

   The "Use regular expressions" option applies both to the
   search string and to the replacement text; for the latter back
   references can be used - see the entry for '\n' in Table 3-2.
     _________________________________________________________

3.5.5. Go to tag definition

   If the current word is the name of a function and the file
   containing the function definition (a.k.a. function body) is
   open, Go to tag definition will switch to that file and go to
   the corresponding line number. The current word is either
   taken from the word nearest the edit cursor, or the word
   underneath the popup menu click position when the popup menu
   is used.
     _________________________________________________________

3.5.6. Go to tag declaration

   Like Go to tag definition, but for a forward function
   declaration (a.k.a. function prototype) instead of a function
   definition.
     _________________________________________________________

3.5.7. Go to line

   Go to a particular line number in the current file.
     _________________________________________________________

3.5.8. Regular expressions

   You can use regular expressions in the Find and Replace
   dialogs by selecting the "Use regular expressions" check box.
   The syntax is POSIX-like, as described below in Table 3-2.

   Note

   Searching backwards with regular expressions is not supported.
Enrico Tröger's avatar
Enrico Tröger committed
509 510 511 512 513

   Table 3-2. Regular expressions
   In a regular expression, the following characters are
   interpreted:
   . Matches any character.
Enrico Tröger's avatar
Enrico Tröger committed
514 515
   ( This marks the start of a region for tagging a match.
   ) This marks the end of a tagged region.
Enrico Tröger's avatar
Enrico Tröger committed
516 517
   \n Where n is 1 through 9 refers to the first through ninth
   tagged region when replacing. For example, if the search
Enrico Tröger's avatar
Enrico Tröger committed
518 519
   string was Fred([1-9])XXX and the replace string was Sam\1YYY,
   when applied to Fred2XXX this would generate Sam2YYY.
Enrico Tröger's avatar
Enrico Tröger committed
520 521 522 523
   \< This matches the start of a word.
   \> This matches the end of a word.
   \x This allows you to use a character x that would otherwise
   have a special meaning. For example, \[ would be interpreted
Enrico Tröger's avatar
Enrico Tröger committed
524 525
   as [ and not as the start of a character set. Use \\ for a
   literal backslash.
Enrico Tröger's avatar
Enrico Tröger committed
526 527 528 529 530 531
   [...] This indicates a set of characters, for example, [abc]
   means any of the characters a, b or c. You can also use
   ranges, for example [a-z] for any lower case character.
   [^...] The complement of the characters in the set. For
   example, [^A-Za-z] means any character except an alphabetic
   character.
Enrico Tröger's avatar
Enrico Tröger committed
532 533
   ^ This matches the start of a line (unless used inside a set,
   see above).
Enrico Tröger's avatar
Enrico Tröger committed
534 535 536 537 538
   $ This matches the end of a line.
   * This matches 0 or more times. For example, Sa*m matches Sm,
   Sam, Saam, Saaam and so on.
   + This matches 1 or more times. For example, Sa+m matches Sam,
   Saam, Saaam and so on.
Enrico Tröger's avatar
Enrico Tröger committed
539 540 541 542 543 544 545

   Note Partial POSIX compatibility


   Note that the POSIX '?' regular expression character for
   optional matching is not supported by the Find and Replace
   dialogs.
Enrico Tröger's avatar
Enrico Tröger committed
546 547
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
548
3.6. Preferences
Enrico Tröger's avatar
Enrico Tröger committed
549 550 551 552 553 554 555

   should be written

   Figure 3-2. General tab in preferences dialog

   [pref_dialog_gen.jpg]

Enrico Tröger's avatar
Enrico Tröger committed
556 557 558 559 560 561 562 563 564
   Figure 3-3. Interface tab in preferences dialog

   [pref_dialog_interface.jpg]

   Figure 3-4. Toolbar tab in preferences dialog

   [pref_dialog_toolbar.jpg]

   Figure 3-5. Editor tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
565 566 567

   [pref_dialog_edit.jpg]

Enrico Tröger's avatar
Enrico Tröger committed
568
   Figure 3-6. Tools tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
569 570 571

   [pref_dialog_tools.jpg]

Enrico Tröger's avatar
Enrico Tröger committed
572
   Figure 3-7. Template tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
573 574

   [pref_dialog_templ.jpg]
Enrico Tröger's avatar
Enrico Tröger committed
575

Enrico Tröger's avatar
Enrico Tröger committed
576
   Figure 3-8. Keybinding tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
577 578 579 580 581

   [pref_dialog_keys.jpg]

   Note

Enrico Tröger's avatar
Enrico Tröger committed
582
   For more information see Section 3.9.
Enrico Tröger's avatar
Enrico Tröger committed
583

Enrico Tröger's avatar
Enrico Tröger committed
584
   Figure 3-9. VTE tab in preferences dialog
Enrico Tröger's avatar
Enrico Tröger committed
585 586 587 588

   [pref_dialog_vte.jpg]
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
589
3.6.1. Compile time options
Enrico Tröger's avatar
Enrico Tröger committed
590

Enrico Tröger's avatar
Enrico Tröger committed
591 592 593 594
   There are some options which can only be changed at compile
   time. To change these options, edit the file src/geany.h. Look
   for a block of lines starting with "#define GEANY_*". Any
   definitions which are not listed here should not be changed.
Enrico Tröger's avatar
Enrico Tröger committed
595 596 597

   Table 3-3. Compile time options
   Option Description Default
Enrico Tröger's avatar
Enrico Tröger committed
598 599
   GEANY_MAX_OPEN_FILES The limit to how many files can be open
   at the same time. 25
Enrico Tröger's avatar
Enrico Tröger committed
600 601 602
   GEANY_SESSION_FILES How many files should be reopened from the
   last run. Obviously, the value should be smaller than
   GEANY_MAX_OPEN_FILES. 15
Enrico Tröger's avatar
Enrico Tröger committed
603 604 605
   GEANY_WORDCHARS These characters define word boundaries. (look
   at sourcecode)
   GEANY_MAX_AUTOCOMPLETE_WORDS How many auto completion
Enrico Tröger's avatar
Enrico Tröger committed
606
   suggestions should Geany provide. 30
Enrico Tröger's avatar
Enrico Tröger committed
607 608 609 610 611
   GEANY_STRING_UNTITLED A string used as the default name for
   new files. Be aware that the string can be translated, so
   change it only if you know what you are doing. untitled
   GEANY_CHECK_FILE_DELAY Time in seconds between checking a file
   for external changes. 30
Enrico Tröger's avatar
Enrico Tröger committed
612 613 614 615 616 617 618 619
   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 first start. 900
   GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main
   window at the first start. 600
620 621 622 623 624 625 626 627 628 629 630
   Default values
   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 the command line option "-e". This can also include a
   path. "xterm"
   GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also
   include a path. "mozilla"
   GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be
   able to accept and process plain text files. This can also
   include a path. "lpr"
Enrico Tröger's avatar
Enrico Tröger committed
631 632
   GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible
   with GNU grep. This can also include a path. "grep"
633 634 635 636 637 638 639 640
   GEANY_DEFAULT_MRU_LENGHTH The length of the "Recent files"
   list. "10"
   GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to
   show symbols and open files. "Cursor 8"
   GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages
   window. "Cursor 8"
   GEANY_DEFAULT_FONT_EDITOR The font used in the editor window.
   "Courier New 9"
Enrico Tröger's avatar
Enrico Tröger committed
641 642
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
643
3.7. Build system
Enrico Tröger's avatar
Enrico Tröger committed
644

645 646 647 648 649 650 651
   Geany has an integrated build system. Firstly this means that
   the current source file will be saved before it is processed.
   This is for convenience so that you don't need to keep saving
   small changes to the current file before building.

   Secondly the output for Compile, Build and Make actions will
   be captured in the Compiler notebook tab of the messages
Enrico Tröger's avatar
Enrico Tröger committed
652 653 654 655
   window (assuming you have it visible). If there are any
   warnings or errors with line numbers shown in the Compiler
   output tab, you can double click on them and Geany will switch
   to the relevant source file (if it is open) and mark the line
Enrico Tröger's avatar
Enrico Tröger committed
656 657
   number so the problem can be corrected. Geany will also set
   indicators for warnings or errors with line numbers.
Enrico Tröger's avatar
Enrico Tröger committed
658 659 660 661 662 663

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

     * Compile
     * Build
Enrico Tröger's avatar
Enrico Tröger committed
664 665 666
     * Make all
     * Make custom target
     * Make object
Enrico Tröger's avatar
Enrico Tröger committed
667 668 669
     * Execute
     * Set Includes and Arguments
     _________________________________________________________
Enrico Tröger's avatar
Enrico Tröger committed
670

Enrico Tröger's avatar
Enrico Tröger committed
671
3.7.1. Compile
Enrico Tröger's avatar
Enrico Tröger committed
672

673 674
   The Compile command has different uses for different kinds of
   files.
Enrico Tröger's avatar
Enrico Tröger committed
675

676 677 678 679 680 681 682 683 684
   For compilable languages such as C and C++, the Compile
   command is setup to compile the current source 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 will run a syntax
   check, or failing that will run the file in its language
   interpreter.
Enrico Tröger's avatar
Enrico Tröger committed
685 686
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
687
3.7.2. Build
Enrico Tröger's avatar
Enrico Tröger committed
688 689 690 691 692 693 694 695 696 697

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

   Interpreted languages do not use the Build command.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
698
3.7.3. Make all
Enrico Tröger's avatar
Enrico Tröger committed
699 700

   This effectively runs "make all" in the same directory as the
Enrico Tröger's avatar
Enrico Tröger committed
701 702 703 704 705 706
   current file.

   Note

   For each of the Make commands, The Make tool path must be
   correctly set in the Tools tab of the Preferences dialog.
Enrico Tröger's avatar
Enrico Tröger committed
707 708
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
709
3.7.4. Make custom target
Enrico Tröger's avatar
Enrico Tröger committed
710

Enrico Tröger's avatar
Enrico Tröger committed
711 712 713 714
   This is similar to running 'Make all' but you will be prompted
   for the make target name to be passed to the Make tool. For
   example, typing 'clean' in the dialog prompt will run "make
   clean".
Enrico Tröger's avatar
Enrico Tröger committed
715 716
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
717 718 719 720 721 722 723 724 725
3.7.5. Make object

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

3.7.6. Execute
Enrico Tröger's avatar
Enrico Tröger committed
726 727 728 729 730

   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 can use any terminal program
731 732 733 734 735 736
   that runs a Bourne compatible shell.

   After your program or script has finished executing, you will
   be prompted to press the return key. This allows you to review
   any text output from the program before the terminal window is
   closed.
Enrico Tröger's avatar
Enrico Tröger committed
737 738
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
739
3.7.7. Set Includes and Arguments
Enrico Tröger's avatar
Enrico Tröger committed
740 741 742 743 744 745

   By default the Compile and Build commands invoke the compiler
   and linker with only the basic arguments needed by all
   programs. Using Set Includes and Arguments you can add any
   include paths and compile flags for the compiler, any library
   names and paths for the linker, and any arguments you want to
746 747 748 749 750 751 752
   use when running Execute.

   Note

   If you are using the Build command to compile and link in one
   step, you will need to set both the compiler arguments and the
   linker arguments in the linker command setting.
Enrico Tröger's avatar
Enrico Tröger committed
753 754 755 756 757

   These settings are not saved when Geany is shut down. See
   below for how to set permanent arguments.

   If you need complex settings for your build system, or several
Enrico Tröger's avatar
Enrico Tröger committed
758 759
   different settings, then writing a Makefile and using the Make
   commands is recommended.
760 761
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
762
3.7.8. Indicators
763 764 765 766 767 768 769 770 771

   Indicators are red squiggly underlines which are used to
   highlight errors which occured while compiling the current
   file. So you can easily see where your code failed to compile.
   To remove the indicators, just click on "Remove all
   indicators" in the document file menu.

   If you do not like this feature, you can disable it in the
   preferences dialog.
Enrico Tröger's avatar
Enrico Tröger committed
772 773
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
774
3.7.9. File type configuration settings
Enrico Tröger's avatar
Enrico Tröger committed
775 776 777

   You can set the commands to run for compiling, building or
   executing by opening the relevant filetypes.* configuration
778
   file, and checking the [build_settings] section. See Section
Enrico Tröger's avatar
Enrico Tröger committed
779
   4.1 for more information.
Enrico Tröger's avatar
Enrico Tröger committed
780 781
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
782
3.8. Printing support
783

Enrico Tröger's avatar
Enrico Tröger committed
784
   Geany has basic printing support. This means you can print a
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
   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 filename is 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 command itself, so you
   should make sure that it works before(e.g. by trying to
   execute it from the command line).

   A nicer example, which I 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 be used.

   Note

   The printing support of Geany will be improved in the future.
   With GTK 2.10, better printing (including syntax highlighting)
   will be possible.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
810 811 812 813 814 815 816
3.9. Keybindings

   Geany supports the default keyboard shortcuts for the
   Scintilla editing widget. For a list of these commands, see
   Appendix A. The Scintilla keyboard shortcuts will be
   overridden by any custom keybindings with the same keyboard
   shortcut.
Enrico Tröger's avatar
Enrico Tröger committed
817

Enrico Tröger's avatar
Enrico Tröger committed
818 819 820 821 822 823
   For all actions listed below you can define your own
   keybindings. Open the Preferences dialog, select the desired
   action and click on change. In the opening dialog you can
   press any key combination you want and it will be saved when
   you press OK. You can define only one key combination for one
   action.
Enrico Tröger's avatar
Enrico Tröger committed
824 825 826 827 828 829 830 831

   Some of the default key combinations cannot be changed, e.g.
   menu_new or menu_open. These are set by GTK and should be
   kept, but you can still add other key combinations for these
   actions. For example to execute menu_open by default Ctrl-O is
   set, but you can also define Alt-O, so that the file open
   dialog is shown by pressing either Ctrl-O or Alt-O.

Enrico Tröger's avatar
Enrico Tröger committed
832
   The following table lists all customizable keyboard shortcuts.
Enrico Tröger's avatar
Enrico Tröger committed
833 834 835 836

   Table 3-4. Keybindings action table
   Action Description
   Menu items
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
   New Creates a new file.
   Open Opens a file.
   Save Saves the current file.
   Save all Saves all open files.
   Close all Closes all open files.
   Close Closes the current file.
   Reload file Reloads the current file. All unsaved changes will
   be lost.
   Print Prints the current file.
   Undo Undoes the last action.
   Redo Redoes the last action.
   Select all Makes a selection of all text in the current
   document.
   Preferences Opens preferences dialog.
   Find Next Finds next result.
   Find Previous Finds previous result.
Enrico Tröger's avatar
Enrico Tröger committed
853 854 855 856
   Replace Opens the Replace dialog.
   Find in files Opens the Find in files dialog.
   Go to line Opens the Go to line dialog.
   Show Colour Chooser Opens the Colour Chooser dialog.
857 858
   Fullscreen Switches to fullscreen mode.
   Toggle Messages Window Toggles the message window (status and
Enrico Tröger's avatar
Enrico Tröger committed
859
   compiler messages) on and off.
860 861 862 863 864 865 866
   Toggle Sidebar Shows or hides the sidebar.
   Zoom In Zooms in the text
   Zoom Out Zooms out the text
   Replace tabs by space Replaces all tabs with the right amount
   of spaces.
   Fold all Folds all contractible code blocks.
   Unfold all Unfolds all contracted code blocks.
Enrico Tröger's avatar
Enrico Tröger committed
867
   Build options
868 869 870
   Compile Compiles the current file.
   Build Builds (compiles if necessary and links) the current
   file.
Enrico Tröger's avatar
Enrico Tröger committed
871 872 873 874
   Make all Builds the current file with the Make tool.
   Make custom target Builds the current file with the Make tool
   and a given target.
   Make object Compiles the current file with the Make tool.
875 876 877 878
   Run Executes the current file in a terminal emulation.
   Run (alternative command) Executes the current file in a
   terminal emulation.
   Build options Opens the build options dialog.
Enrico Tröger's avatar
Enrico Tröger committed
879
   Miscellaneous
880 881 882 883 884 885 886
   Reload symbol list Reloads the tag/symbol list.
   Switch to Editor Switches to editor widget.
   Switch to Scribble Switches to scribble widget.
   Switch to VTE Switches to VTE widget.
   Switch to left document Switches to the previous open
   document.
   Switch to right document Switches to the next open document.
Enrico Tröger's avatar
Enrico Tröger committed
887
   Editing operations
888 889 890 891 892
   Duplicate line or selection Duplicates the current line or
   selection.
   Comment line Comments current line or selection.
   Complete word Shows auto completion list.
   Show calltip Shows call tips for the current function or
Enrico Tröger's avatar
Enrico Tröger committed
893
   method.
894
   Show macro list Shows a list of available macros and variables
Enrico Tröger's avatar
Enrico Tröger committed
895
   in the workspace.
896
   Suppress auto completion If you type something like if or for
Enrico Tröger's avatar
Enrico Tröger committed
897
   and press this key, it will not be auto completed.
Enrico Tröger's avatar
Enrico Tröger committed
898 899 900 901 902 903
   Find Usage Finds all occurrences of the current word (near the
   keyboard cursor) and displays them in the messages window.
   Go to tag definition Jump to the definition of the current
   word (near the keyboard cursor). If the definition cannot be
   found (e.g. the relevant file is not open) Geany will beep and
   do nothing. Used for function definitions.
904
   Go to tag declaration Jump to the declaration of the current
Enrico Tröger's avatar
Enrico Tröger committed
905 906 907
   word (near the keyboard cursor). If the declaration cannot be
   found (e.g. the relevant file is not open) Geany will beep and
   do nothing. Used for function prototypes.
Enrico Tröger's avatar
Enrico Tröger committed
908 909
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
910 911 912
Chapter 4. Configuration files

4.1. Filetype definition files
Enrico Tröger's avatar
Enrico Tröger committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944

   All colour definitions and other filetype specific settings
   are stored in the filetype definition files. Those settings
   are colours for syntax highlighting, general settings like
   comment characters or word delimiter characters as well as
   compiler and linker settings.

   The system-wide configuration files can be found in
   $prefix/share/geany and are called filetypes.$ext, where
   $prefix is the path where Geany is installed (commonly
   /usr/local) and $ext is the 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. It is
   not recommended to edit the system-wide files, because they
   will be overridden when Geany is updated.

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

   For example:
% cp /usr/local/share/geany/filetypes.c /home/username/.geany/filedefs/

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

Enrico Tröger's avatar
Enrico Tröger committed
945
4.1.1. Format
Enrico Tröger's avatar
Enrico Tröger committed
946

Enrico Tröger's avatar
Enrico Tröger committed
947
4.1.1.1. [styling] Section
Enrico Tröger's avatar
Enrico Tröger committed
948 949 950 951 952 953 954 955 956 957 958 959 960

   In this section the colours for syntax highlighting are
   defined. The format is always:
   key=forground_colour;background_colour;bold;italic

   Colours 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 and should only be "true" or
   "false". If their value is something other than "true" or
   "false", "false" is assumed.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
961
4.1.1.2. [keywords] Section
Enrico Tröger's avatar
Enrico Tröger committed
962 963 964 965 966 967 968 969 970 971 972 973

   This section contains keys for different keyword lists
   specific to the filetype. Some filetypes do not support
   keywords, 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.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
974
4.1.1.3. [settings] Section
Enrico Tröger's avatar
Enrico Tröger committed
975

Enrico Tröger's avatar
Enrico Tröger committed
976
   Table 4-1. General settings
Enrico Tröger's avatar
Enrico Tröger committed
977 978 979 980 981 982 983 984 985 986 987 988
   Key Description Example
   wordchars Word delimiting characters. These characters define
   word boundaries. (look at sourcecode)
   comment_open A character or string which is used to comment
   code. If you want to use multiline comments, also set
   comment_close, otherwise leave it empty. comment_open=/*
   comment_close If multiline comments are used, this is the
   character or string to close the comment. 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 it
   uses any indentation of the line.

Enrico Tröger's avatar
Enrico Tröger committed
989
   Example 4-1. Comment indentation
Enrico Tröger's avatar
Enrico Tröger committed
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004

   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.
   comment_use_indent=true
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1005
4.1.1.4. [build_settings] Section
Enrico Tröger's avatar
Enrico Tröger committed
1006

Enrico Tröger's avatar
Enrico Tröger committed
1007
   Table 4-2. Build settings
Enrico Tröger's avatar
Enrico Tröger committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
   Key Description Example
   compiler This item specifies the command to compile source
   code files. But it is also possible to use it with interpreted
   languages like Perl or Python. With these filetypes you can
   use this option as a kind of syntax parser, which sends output
   to the compiler message window.

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

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

   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 compiled while
   linking. The -o option is automatically added by Geany. This
   item works well with GNU gcc, but may be problematic with
   other compilers (esp. with the linker). 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 only the name
   of the executable (i.e. without extension) or use the %f
   wildcard if you need the complete filename, e.g. for shell
   scripts. run_cmd="./%e"
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1034
4.1.2. Special file filetypes.common
Enrico Tröger's avatar
Enrico Tröger committed
1035 1036 1037 1038 1039

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

Enrico Tröger's avatar
Enrico Tröger committed
1040
   Table 4-3. General settings
Enrico Tröger's avatar
Enrico Tröger committed
1041
   Key Description Example
Enrico Tröger's avatar
Enrico Tröger committed
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
   selection The style for colouring selected text. The format
   is:

     * Foreground colour
     * Background colour
     * Use foreground colour
     * Use background colour

   The colours are only set if the 3rd or 4th argument is true.
   When the colours are not overridden, the default is a dark
   grey background with syntax highlighted foreground text.
   selection=0xc0c0c0;0x00007F;true;true
Enrico Tröger's avatar
Enrico Tröger committed
1054 1055 1056 1057
   brace_good The style for brace highlighting when a matching
   brace was found. brace_good=0xff0000;0xFFFFFF;true;false
   brace_bad The style for brace highlighting when no matching
   brace was found. brace_bad=0x0000ff;0xFFFFFF;true;false
Enrico Tröger's avatar
Enrico Tröger committed
1058 1059 1060
   caret The style for colouring the caret(the blinking cursor).
   Only the first argument is interpreted.
   caret=0x000000;0x0;false;false
Enrico Tröger's avatar
Enrico Tröger committed
1061 1062
   current_line The style for colouring the background of the
   current line. Only the second argument is interpreted.
Enrico Tröger's avatar
Enrico Tröger committed
1063 1064 1065 1066 1067 1068 1069 1070 1071
   current_line=0x0;0xe5e5e5;false;false
   indent_guide The style for colouring the indentation guides.
   Only the first and second arguments are interpreted.
   indent_guide=0xc0c0c0;0xffffff;false;false
   white_space The style for colouring the white space if it is
   shown. The first both arguments define the foreground and
   background colours, the third argument sets whether to use the
   defined colours or to use the colours defined by each filetype
   for the white space. white_space=0xc0c0c0;0xffffff;true;false
Enrico Tröger's avatar
Enrico Tröger committed
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
   folding_style The style of folding icons. Only first and
   second arguments are used.

   Valid values for the first argument are:

     * 1 - for boxes
     * 2 - for circles

   Valid values for the second argument are:

     * 1 - for straight lines
     * 2 - for curved lines

   folding_style=1;1;false;false
1086 1087 1088 1089 1090 1091 1092 1093
   invert_all Whether to invert all defined colours. This is
   useful if you like a dark background colour(e.g. black) and do
   not want to change every single line. Please note, at time of
   writing this was only tested with the C syntax highlighting.

   Only first argument is interpreted. Set it to 1 to invert all
   colours.
   invert_all=0;0;false;false
Enrico Tröger's avatar
Enrico Tröger committed
1094 1095
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
4.2. Filetype extensions

   You can override the default extensions that Geany uses for
   each filetype using the filetype_extensions.conf file.

   To override the system-wide configuration file, copy it from
   $prefix/share/geany to your configuration directory, usually
   ~/.geany/. $prefix is the path where Geany is installed
   (commonly /usr/local).

   For example:
% cp /usr/local/share/geany/filetype_extensions.conf /home/username/.ge
any/

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

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

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

4.3. Templates
Enrico Tröger's avatar
Enrico Tröger committed
1123 1124

   Geany supports several templates for file headers, multiline
Enrico Tröger's avatar
Enrico Tröger committed
1125 1126 1127
   comments (frame comments), function descriptions, a typical
   ChangeLog entry and a short GPL notice. To use these
   templates, just open the Edit menu or open the popup menu by
Enrico Tröger's avatar
Enrico Tröger committed
1128 1129 1130
   right-clicking in the editor widget, and choose "Insert
   Comments" and insert templates as you want.

Enrico Tröger's avatar
Enrico Tröger committed
1131
   Some templates (like file header or ChangeLog entry) will
Enrico Tröger's avatar
Enrico Tröger committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
   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 be determined
   automatically. The description will be positioned correctly
   one line above the function, just check it out. If the cursor
   is not inside of a function or the function name cannot be
   determined, you cannot insert a function description.

   Each template can be customized to your needs. The templates
   are in the configuration directory, which is in ~/.geany/ (see
Enrico Tröger's avatar
Enrico Tröger committed
1143
   Section 3.2 for further information about the configuration
Enrico Tröger's avatar
Enrico Tröger committed
1144 1145 1146 1147 1148 1149 1150
   directory). Just open the desired template with an editor
   (ideally Geany ;-) ) and edit the template as your needs.
   There are some wildcards which will be automatically replaced
   by Geany at startup.

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

Enrico Tröger's avatar
Enrico Tröger committed
1151
   In the configuration dialog you can find a tab "Templates"
Enrico Tröger's avatar
Enrico Tröger committed
1152
   (see Figure 3-7). You can define the default values which will
Enrico Tröger's avatar
Enrico Tröger committed
1153 1154
   be inserted in the templates. You should restart Geany after
   making changes, because they are only read at startup.
Enrico Tröger's avatar
Enrico Tröger committed
1155 1156 1157 1158 1159 1160

   Since Geany 0.3 there are also templates for creating new
   files. They can be found in ~/.geany/, too. All template files
   for creating new files begin with template.filetype. followed
   by the filetype. At creating a new file with a filetype
   template, the template for the fileheader is automatically
Enrico Tröger's avatar
Enrico Tröger committed
1161
   prepended. Please note that the complete behaviour is still
Enrico Tröger's avatar
Enrico Tröger committed
1162 1163 1164 1165
   under development and will probably be changed in one of the
   next releases. Sorry.


Enrico Tröger's avatar
Enrico Tröger committed
1166
   Table 4-4. Template wildcards
Enrico Tröger's avatar
Enrico Tröger committed
1167 1168 1169
   Wildcard Description Available in following templates
   developer The name of the developer. filetypes, file header,
   function description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1170
   initial The developer's initials, e.g. "ET" for Enrico Tröger
Enrico Tröger's avatar
Enrico Tröger committed
1171 1172
   or "JFD" for John Foobar Doe. filetypes, file header, function
   description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1173 1174
   mail The email address of the developer. file header, function
   description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1175 1176
   company The company the developer is working for. filetypes,
   file header, function description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1177 1178 1179 1180 1181 1182 1183 1184 1185
   year The current year in the format: YYYY filetypes, file
   header, function description, ChangeLog entry
   version The initial version of a new file. filetypes, file
   header, function description, ChangeLog entry
   date The current date in the format: YYYY-MM-DD filetypes,
   file header, function description, ChangeLog entry
   untitled The string "untitled" (this will be translated to
   your locale), used in filetype templates filetypes, file
   header, function description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1186
   geanyversion The actual Geany version, e.g. "Geany 0.9"
Enrico Tröger's avatar
Enrico Tröger committed
1187
   filetypes, file header, function description, ChangeLog entry
Enrico Tröger's avatar
Enrico Tröger committed
1188 1189 1190 1191 1192
   datetime The current date and time in the format: DD.MM.YYYY
   HH:mm:ss ZZZZ file header, function description
   filename The filename of the current file. Only available for
   the file header template. file header
   gpl This wildcard inserts a short GPL notice. file header
Enrico Tröger's avatar
Enrico Tröger committed
1193
   functionname The function name of the function at the cursor
Enrico Tröger's avatar
Enrico Tröger committed
1194 1195 1196 1197 1198 1199
   position. This wildcard will only be replaced in the function
   description template. function description
   If you need any other wildcards or a special date/time format,
   please email the author <enrico.troeger@uvena.de>.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
Appendix A. Scintilla keyboard commands

A.1. 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 the Shift key, and the rectangular selection when
   holding the Shift and Alt keys. Some keys may not be available
   with some national keyboards or because they are taken by the
   system such as by a window manager on GTK+. Keyboard
   equivalents of menu commands are listed in the menus. Some
   less common commands with no menu equivalent are:

   Table A-1. Scintilla keyboard commands
                      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
   Delete to end of line.                       Ctrl+Shift+Delete
   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
   Go to end of display line.                   Alt+End
   Extend selection to end of display line.     Alt+Shift+End
   Scroll up.                                   Ctrl+Up
   Scroll down.                                 Ctrl+Down
   Line cut.                                    Ctrl+L
   Line copy.                                   Ctrl+Shift+T
   Line delete.                                 Ctrl+Shift+L
   Line transpose with previous.                Ctrl+T
   Selection duplicate.                         Ctrl+D
   Previous paragraph. Shift extends selection. Ctrl+[
   Next paragraph. Shift extends selection.     Ctrl+]
   Previous word. Shift extends selection.      Ctrl+Left
   Next word. Shift extends selection.          Ctrl+Right
   Previous word part. Shift extends selection  Ctrl+/
   Next word part. Shift extends selection.     Ctrl+\
     _________________________________________________________

Appendix B. GNU General Public License
Enrico Tröger's avatar
Enrico Tröger committed
1249

Enrico Tröger's avatar
Enrico Tröger committed
1250
B.1. Preamble
Enrico Tröger's avatar
Enrico Tröger committed
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307

   The licenses for most software are designed to take away your
   freedom to share and change it. By contrast, the GNU General
   Public License is intended to guarantee your freedom to share
   and change free software - to make sure the software is free
   for all its users. This General Public License applies to most
   of the Free Software Foundation's software and to any other
   program whose authors commit to using it. (Some other Free
   Software Foundation software is covered by the GNU Library
   General Public License instead.) You can apply it to your
   programs, too.

   When we speak of free software, we are referring to freedom,
   not price. Our General Public Licenses are designed to make
   sure that you have the freedom to distribute copies of free
   software (and charge for this service if you wish), that you
   receive source code or can get it if you want it, that you can
   change the software or use pieces of it in new free programs;
   and that you know you can do these things.

   To protect your rights, we need to make restrictions that
   forbid anyone to deny you these rights or to ask you to
   surrender the rights. These restrictions translate to certain
   responsibilities for you if you distribute copies of the
   software, or if you modify it.

   For example, if you distribute copies of such a program,
   whether gratis or for a fee, you must give the recipients all
   the rights that you have. You must make sure that they, too,
   receive or can get the source code. And you must show them
   these terms so they know their rights.

   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
   certain that everyone understands that there is no warranty
   for this free software. If the software is modified by someone
   else and passed on, we want its recipients to know that what
   they have is not the original, so that any problems introduced
   by others will not reflect on the original authors'
   reputations.

   Finally, any free program is threatened constantly by software
   patents. We wish to avoid the danger that redistributors of a
   free program will individually obtain patent licenses, in
   effect making the program proprietary. To prevent this, we
   have made it clear that any patent must be licensed for
   everyone's free use or not licensed at all.

   The precise terms and conditions for copying, distribution and
   modification follow.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1308
B.2. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
Enrico Tröger's avatar
Enrico Tröger committed
1309

Enrico Tröger's avatar
Enrico Tröger committed
1310
B.2.1. Section 0
Enrico Tröger's avatar
Enrico Tröger committed
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332

   This License applies to any program or other work which
   contains a notice placed by the copyright holder saying it may
   be distributed under 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 another language.
   (Hereinafter, translation is included without limitation in
   the term "modification ".) Each licensee is addressed as
   "you".

   Activities other than copying, distribution and modification
   are not covered by this License; they are outside its scope.
   The act of running the Program is not restricted, and the
   output from the Program is covered only if its contents
   constitute a work based on the Program (independent of having
   been made by running the Program). Whether that is true
   depends on what the Program does.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1333
B.2.2. Section 1
Enrico Tröger's avatar
Enrico Tröger committed
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347

   You may copy and distribute verbatim copies of the Program's
   source code as you receive it, in any medium, provided that
   you conspicuously and appropriately publish on each copy an
   appropriate copyright notice and disclaimer of warranty; keep
   intact all the notices that refer to this License and to the
   absence of any warranty; and give any other recipients of the
   Program a copy of this License along 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.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1348
B.2.3. Section 2
Enrico Tröger's avatar
Enrico Tröger committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404

   You may modify your copy or copies of the Program or any
   portion of it, thus forming a work based on the Program, and
   copy and distribute such modifications or work under the terms
   of Section 1 above, provided that you also meet all of these
   conditions:

    1. You must cause the modified files to carry prominent
       notices stating that you changed the files and the date of
       any change.
    2. 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.
    3. 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.

       Note 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. If
   identifiable sections of that work are not derived from the
   Program, and can be reasonably considered independent and
   separate works in themselves, then this License, and its
   terms, do not apply to those sections when you distribute them
   as separate works. But when you distribute the same sections
   as part of a whole which is a work based on the Program, the
   distribution of the whole must be on the terms of this
   License, whose permissions for other licensees extend to the
   entire 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
   contest your rights to work written entirely by you; rather,
   the intent is to exercise the right to control the
   distribution of derivative or collective works based on the
   Program.

   In addition, mere aggregation of another work not based on the
   Program with the Program (or with a work based on the Program)
   on a volume of a storage or distribution medium does not bring
   the other work under the scope of this License.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1405
B.2.4. Section 3
Enrico Tröger's avatar
Enrico Tröger committed
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449

   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 of Sections 1 and 2 above provided that you also do
   one of the following:

    1. 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,
    2. 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,
    3. 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 for making modifications to it. For an executable work,
   complete source code means all the source code for all modules
   it contains, plus any associated interface definition files,
   plus the scripts used to control compilation and installation
   of the executable. However, as a special exception, the source
   code distributed need not include anything that is normally
   distributed (in either source or binary form) with the major
   components (compiler, kernel, and so on) of the operating
   system on which the executable runs, unless that component
   itself accompanies the executable.

   If distribution of executable or object code is made by
   offering access to copy from a designated place, then offering
   equivalent access to copy the source code from the same place
   counts as distribution of the source code, even though third
   parties are not compelled to copy the source along with the
   object code.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1450
B.2.5. Section 4
Enrico Tröger's avatar
Enrico Tröger committed
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461

   You may not copy, modify, sublicense, or distribute the
   Program except as expressly provided under this License. Any
   attempt otherwise to copy, modify, sublicense or distribute
   the Program is void, and will automatically terminate your
   rights under this License. However, parties who have received
   copies, or rights, from you under this License will not have
   their licenses terminated so long as such parties remain in
   full compliance.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1462
B.2.6. Section 5
Enrico Tröger's avatar
Enrico Tröger committed
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474

   You are not required to accept this License, since you have
   not signed it. However, nothing else grants you permission to
   modify or distribute the Program or its derivative works.
   These actions are prohibited by law if you do not accept this
   License. Therefore, by modifying or distributing the Program
   (or any work based on the Program), you indicate your
   acceptance of this License to do so, and all its terms and
   conditions for copying, distributing or modifying the Program
   or works based on it.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1475
B.2.7. Section 6
Enrico Tröger's avatar
Enrico Tröger committed
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485

   Each time you redistribute the Program (or any work based on
   the Program), the recipient automatically receives a license
   from the original licensor to copy, distribute or modify the
   Program subject to these terms and conditions. You may not
   impose any further restrictions on the recipients' exercise of
   the rights granted herein. You are not responsible for
   enforcing compliance by third parties to this License.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1486
B.2.8. Section 7
Enrico Tröger's avatar
Enrico Tröger committed
1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523

   If, as a consequence of a court judgment or allegation of
   patent infringement or for any other reason (not limited to
   patent issues), conditions are imposed on you (whether by
   court order, agreement or otherwise) that contradict the
   conditions of this License, they do not excuse you from the
   conditions of this License. If you cannot distribute so as to
   satisfy simultaneously your obligations under this License and
   any other pertinent obligations, then as a consequence you may
   not distribute the Program at all. For example, if a patent
   license would not permit royalty-free redistribution of the
   Program by all those who receive copies directly or indirectly
   through you, then the only way you could satisfy both it and
   this License would be to refrain entirely from distribution of
   the Program.

   If any portion of this section is held invalid or
   unenforceable under any particular circumstance, the balance
   of the section is intended to apply and the section as a whole
   is intended to apply in other circumstances.

   It is not the purpose of this section to induce you to
   infringe any patents or other property right claims or to
   contest validity of any such claims; this section has the sole
   purpose of protecting the integrity of the free software
   distribution system, which is implemented by public license
   practices. Many people have made generous contributions to the
   wide range of software distributed through that system in
   reliance on consistent application of that system; it is up to
   the author/donor to decide if he or she is willing to
   distribute software through any other system and a licensee
   cannot impose that choice.

   This section is intended to make thoroughly clear what is
   believed to be a consequence of the rest of this License.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1524
B.2.9. Section 8
Enrico Tröger's avatar
Enrico Tröger committed
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535

   If the distribution and/or use of the Program is restricted in
   certain countries either by patents or by copyrighted
   interfaces, the original copyright holder who places the
   Program under this License may add an explicit geographical
   distribution limitation excluding those countries, so that
   distribution is permitted only in or among countries not thus
   excluded. In such case, this License incorporates the
   limitation as if written in the body of this License.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1536
B.2.10. Section 9
Enrico Tröger's avatar
Enrico Tröger committed
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552

   The Free Software Foundation may publish revised and/or new
   versions of the General Public License from time to time. Such
   new versions will be similar in spirit to the present version,
   but may differ in detail to address new problems or concerns.

   Each version is given a distinguishing version number. If the
   Program specifies a version number of this License which
   applies to it and "any later version", you have the option of
   following the terms and conditions either of that version or
   of any later version published by the Free Software
   Foundation. If the Program does not specify a version number
   of this License, you may choose any version ever published by
   the Free Software Foundation.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1553
B.2.11. Section 10
Enrico Tröger's avatar
Enrico Tröger committed
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565

   If you wish to incorporate parts of the Program into other
   free programs whose distribution conditions are different,
   write to the author to ask for permission. For software which
   is copyrighted by the Free Software Foundation, write to the
   Free Software Foundation; we sometimes make exceptions for
   this. Our decision will be guided by the two goals of
   preserving the free status of all derivatives of our free
   software and of promoting the sharing and reuse of software
   generally.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1566
B.2.12. Section 11 NO WARRANTY
Enrico Tröger's avatar
Enrico Tröger committed
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579

   BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
   WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
   APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
   COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS
   IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
   ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
   IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
   THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1580
B.2.13. Section 12
Enrico Tröger's avatar
Enrico Tröger committed
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596

   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
   WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
   MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
   LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
   INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
   INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
   LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
   SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
   TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
   OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
   DAMAGES.

   END OF TERMS AND CONDITIONS
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1597
B.3. How to Apply These Terms to Your New Programs
Enrico Tröger's avatar
Enrico Tröger committed
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663

   If you develop a new program, and you want it to be of the
   greatest possible use to the public, the best way to achieve
   this is to make it free software which everyone can
   redistribute and change under these terms.

   To do so, attach the following notices to the program. It is
   safest to attach them to the start of each source file to most
   effectively convey the exclusion of warranty; and each file
   should have at least the "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., 59 Temple Place, Suite 330, Boston,
   MA 02111-1307 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 this when 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 appropriate parts of the General Public License. Of
   course, the commands you use may be called something other
   than `show w' and `show c'; they could even be mouse-clicks or
   menu items--whatever suits your program.

   You should also get your employer (if you work as a
   programmer) or your school, if any, to sign a "copyright
   disclaimer" for the program, if necessary. 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 into proprietary programs. If your program is a
   subroutine library, you may consider it more useful to permit
   linking proprietary applications with the library. If this is
   what you want to do, use the GNU Library General Public
   License instead of this License.
1664 1665
     _________________________________________________________

Enrico Tröger's avatar
Enrico Tröger committed
1666
Appendix C. License for Scintilla and SciTE
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685

   Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>

   All Rights Reserved

   Permission to use, copy, modify, and distribute this software
   and its documentation for any purpose and without fee is
   hereby granted, provided that the above copyright notice
   appear in all copies and that both that copyright notice and
   this permission notice appear in supporting documentation.

   NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
   SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   AND FITNESS, IN NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY
   SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
   WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
   ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
   PERFORMANCE OF THIS SOFTWARE.