]> Enrico Troeger

&author_mail;

2005 This document is distributed under the terms of the GNU Public license as published by the Free Software Foundation; either version 2 of the License, or (at your option) 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 appendix of this document.

&app; is a small and lightweight integrated development environment. It was developed to provide a small and fast IDE, which has only a few dependencies from other packages. Another goal was to be as independent as possible from a special Desktop Environment like KDE or GNOME. So it is using only the GTK2 toolkit and therefore you need only the GTK2 runtime libraries to run &app;. The basic features of &app; are: syntax highlighting code completion auto completion of often used constructs like if, for and while auto completion of XML and HTML tags call tips many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal symbol lists

You can obtain &app; from &appurl; or perhabs from your distributor.

&app; is distributed under the terms of the GNU Public license as published by the Free Software Foundation; either version 2 of the License, or (at your option) 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 appendix of this document.

For compiling &app; 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. Further more you need, of course, a C compiler, for the included Scintilla library a C++ compiler and the make tool.

Compiling &app; 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 If there are any errors during compilation, check your build environment and try to find the error, otherwise contact the author at &author_mail;.

There are not yet packages for Fedora available.

At the moment, there is only a binary package for Debian Sarge (stable). It is available at &deburl;/. You can add the following line to your apt sources.list to get automatically get the latest version of &app;: deb &deburl;/ ./

There are not yet packages for SuSE available.

There are not yet packages for Fedora available.

You can start &app; in the following ways: From the Desktop Environment menu Choose in your application menu of your used Desktop Environment: Development &app; . From the command line To start &app; from a command line, type the following and press Return: % &app_small;

Short option Long option Function -n --no-ctags Don't load auto completion and call tip data. Use this option, if you don't want to use them. For more information see . -c directory_name --config=directory_name Use an alternate configuration directory. Default configuration directory is ~/.&app_small;/ and there resides &app_small;.conf and some template files. -d --debug Runs &app; in debug mode, which means being verbose and printing lots of information. -? --help Show help information and exit. -v --version Show version information and exit. [files ...] Opens all given files at startup. This option causes &app; to ignore loading stored files from the last session (if enabled). &app; supports all generic GTK options, a list is available on the help screen.

At startup, &app; loads the 15 first files from the last time, &app; was launched. You can disable this feature in the settings dialog(see ). If you specify some files on the commandline, only these files will be opened. But you can find the files from the last session in the file menu. There is an item "Recent files". It contains the last 15 recently opened files. If a C file(with extension is c, cpp, h, etc.) is opened, a global tags file is loaded once, which contains many function declarations from the glibc and some other libraries, like X, Bonobo, Gnome, GTK, Glib and so on. These declarations are used for call tips and auto completion. These tags are only useful if you are writing C or C++ source code. So if you know, that you don't need these things, you can skip loading this tag file. To do so, start &app; with the argument "-n" or "--no-ctags", for more information see .

You can use regular expressions in the search dialog, just by activating the check box(see the image below). Detailed information about special characters can be found in the .

In a regular expression, the following characters are interpreted: . Matches any character. \( This marks the start of a region for tagging a match. \) This marks the end of a tagged region. \n Where n is 1 through 9 refers to the first through ninth tagged region when replacing. For example, if the search string was Fred\([1-9]\)XXX and the replace string was Sam\1YYY, when applied to Fred2XXX this would generate Sam2YYY. \< 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 as [ and not as the start of a character set. [...] 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. $ 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.

should be written

should be written

&app; supports several templates for file headers, multiline comments(frame comments), function descriptions, a typical ChangeLog entry and a short GPL notice. To use this templates, just open the edit menu or open the popup menu by right-clicking in the editor widget, and choose "Insert Comments" and insert templates as you want. Some templates like file header or ChangeLog entry, will always be inserted at the top of the file. To insert a function description, the cursor must be inside of the function, so that the function name can 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 ~/.&app_small;/ (see for further information about configuration directory). Just open the desired template with an editor (ideally &app; ;-) ) and edit the template as your needs. There are some wildcards which will be automatically replaced by &app; at startup. All wildcards must be enclosed by "{" and "}", e.g. {date}. In the configuration dialog you can find a tab "Templates"(see ). You can define the default values which will be inserted in the templates. You should restart &app; after made changes, because they are only read at startup. Since &app; 0.3 there are also templates for creating new files. They can be found in ~/.&app_small;/, 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 prepended. Please note, that the complete behaviour is still under development and will probably be changed in one of the next releases. Sorry.   Wildcard Description Available in following templates developer The name of the developer. filetypes, file header, function description, ChangeLog entry initial The initials of the developer name, e.g. "ET" for Enrico Troeger or "JFD" for John Foobar Doe. filetypes, file header, function description, ChangeLog entry mail The email address of the developer. file header, function description, ChangeLog entry company The company name, the developer is working for. filetypes, file header, function description, ChangeLog entry 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 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 functionname The function name of the function at cursor 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 &author_mail;.

The following table lists several useful key codes, which you can use in &app;. Key Function File operations CtrlN Create new file CtrlO Open file CtrlS Save current file CtrlShiftS Save all open files CtrlW Close current file AltD Close all open files Editing operations CtrlX Cut the current selection and copy it into the clipboard CtrlC Copy the current selection into the clipboard CtrlV Paste the content of the clipboard at the current position CtrlZ Undo the last action CtrlY Redo the last action CtrlG Duplicate the current line CtrlA Select all CtrlD Comment current line or selection CtrlSpace Show auto completion list CtrlReturn Show list of available(in the workspace) macros and variables AltSpace Show call tips for the current function or method ShiftSpace Insert just a blank. Useful after typing if or while, to explicitly suppress the use of construct auto completion CtrlR Reload the tag/symbol list Finding text CtrlF Open find dialog F3 Find next Building files F8 Compile the current file F9 Build the current file CtrlF9 Build the current file with the make tool F5 Execute the current file in a terminal emulation Miscellaneous CtrlLEFT Switch to the previous open document CtrlRIGHT Switch to the next open document Ctrl+ Zoom in the text Ctrl- Zoom out the text CtrlP Open preferences dialog F1 Show help F11 Switch to fullscreen mode F12 Switch to Scribble widget CtrlQ Quit

&legal;