geany-1.31.tar.gz

.. |(version)| replace:: 1.31 .. -*- reStructuredText -*- ======= Geany ======= ------------------------- A fast, light, GTK+ IDE ------------------------- :Authors: Enrico Tröger, Nick Treleaven, Frank Lanitz, Colomban Wendling, Matthew Brush :Date: 2017-07-16 :Version: |(version)| Copyright © 2005-2017 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 program, and also in the chapter `GNU General Public License`_. .. contents:: Introduction ============ About Geany ----------- Geany is a small and lightweight Integrated Development Environment. It was developed to provide a small and fast IDE, which has only a few dependencies on other packages. Another goal was to be as independent as possible from a particular Desktop Environment like KDE or GNOME - Geany only requires the GTK+ runtime libraries. Some basic features of Geany: * Syntax highlighting * Code folding * Autocompletion of symbols/words * Construct completion/snippets * Auto-closing of XML and HTML tags * Calltips * Many supported filetypes including C, Java, PHP, HTML, Python, Perl, Pascal, and others * Symbol lists * Code navigation * Build system to compile and execute your code * Simple project management * Plugin interface Where to get it --------------- You can obtain Geany from http://www.geany.org/ or perhaps also from your distribution. For a list of available 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 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 program and in the chapter, `GNU General Public License`_. The included Scintilla library (found in the subdirectory ``scintilla/``) has its own license, which can be found 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 at http://www.geany.org/. If you want to contribute to it, see `Contributing to this document`_. Installation ============ Requirements ------------ You will need the GTK (>= 2.24) libraries and their dependencies (Pango, GLib and ATK). Your distro should provide packages for these, usually installed by default. For Windows, you can download an installer from the website which bundles these libraries. Binary packages --------------- There are many binary packages available. For an up-to-date but maybe incomplete list see http://www.geany.org/Download/ThirdPartyPackages. Source compilation ------------------ Compiling Geany is quite easy. To do so, you need the GTK (>= 2.24) libraries and header files. You also need 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 are recommended. Autotools based build system ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To compile Geany yourself, you just need the Make tool, preferably GNU Make. Then run the following commands:: $ ./configure $ make Then as root:: % make install Or via sudo:: % sudo make install Custom installation ^^^^^^^^^^^^^^^^^^^ The configure script supports several common options, for a detailed list, type:: $ ./configure --help 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 support for 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, otherwise contact the mailing list or one the authors. Sometimes you might need to ask for specific help from your distribution. Installation prefix ------------------- If you want to find Geany's system files after installation you may want to know the installation prefix. Pass the ``--print-prefix`` option to Geany to check this - see `Command line options`_. The first path is the prefix. On Unix-like systems this is commonly ``/usr`` if you installed from a binary package, or ``/usr/local`` if you build from source. .. note:: Editing system files is not necessary as you should use the per-user configuration files instead, which don't need root permissions. See `Configuration files`_. 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. At Windows-systems you will find Geany after installation inside the application menu within its special folder. * 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: .. image:: ./images/main_window.png The workspace has the following parts: * The menu. * An optional toolbar. * An optional sidebar that can show the following tabs: * Documents - A document list, and * Symbols - 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 in Files' and other actions * Scribble - A text scratchpad for any use. * Terminal - An optional terminal window. * A status bar Most of these can be configured in the `Interface preferences`_, the `View menu`_, or the popup menu for the relevant area. 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 -------------------- ============ ======================= ================================================= Short option 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 the number). 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. -c dir_name --config=directory_name Use an alternate configuration directory. The default configuration directory is ``~/.config/geany/`` and that is where ``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 Gen