011fcde8ea
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@1551 ea778897-0a13-0410-b9d1-a72fbfd435f5
103 lines
9.2 KiB
HTML
103 lines
9.2 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Build system</title><link rel="stylesheet" href="geany.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"><link rel="start" href="index.html" title="Geany 0.11"><link rel="up" href="ch03.html" title="Chapter 3. Usage"><link rel="prev" href="ch03s09.html" title="Project Management"><link rel="next" href="ch03s11.html" title="Printing support"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Build system</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03s09.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Usage</th><td width="20%" align="right"> <a accesskey="n" href="ch03s11.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="build_system"></a>Build system</h2></div></div></div><p>
|
||
<span class="application">Geany</span> 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.
|
||
</p><p>
|
||
Secondly the output for Compile, Build and Make actions will be captured
|
||
in the Compiler notebook tab of the messages 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 <span class="application">Geany</span> will switch to
|
||
the relevant source file (if it is open) and mark the line number so the problem
|
||
can be corrected. <span class="application">Geany</span> will also set indicators for
|
||
warnings or errors with line numbers.
|
||
</p><p>
|
||
Depending on the current file's filetype, the Build menu will contain the following
|
||
items:
|
||
</p><div class="itemizedlist"><ul type="disc"><li><p>Compile</p></li><li><p>Build</p></li><li><p>Make all</p></li><li><p>Make custom target</p></li><li><p>Make object</p></li><li><p>Execute</p></li><li><p>Set Includes and Arguments</p></li></ul></div><p>
|
||
</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812310"></a>Compile</h3></div></div></div><p>
|
||
The Compile command has different uses for different kinds of files.
|
||
</p><p>
|
||
For compilable languages such as C and C++, the Compile command is setup
|
||
to compile the current source file into a binary object file.
|
||
</p><p>
|
||
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.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812335"></a>Build</h3></div></div></div><p>
|
||
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.
|
||
</p><p>
|
||
Interpreted languages do not use the Build command.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812354"></a>Make all</h3></div></div></div><p>
|
||
This effectively runs "make all" in the same directory as the current file.
|
||
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
|
||
For each of the Make commands, The Make tool path must be correctly set
|
||
in the Tools tab of the Preferences dialog.
|
||
</p></div><p>
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812373"></a>Make custom target</h3></div></div></div><p>
|
||
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".
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812386"></a>Make object</h3></div></div></div><p>
|
||
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.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812400"></a>Execute</h3></div></div></div><p>
|
||
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 that runs a Bourne compatible shell and accept the "-e" command line
|
||
argument to start a command.
|
||
</p><p>
|
||
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.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812423"></a>Stopping running processes</h3></div></div></div><p>
|
||
When there is a running program, the Run button in the
|
||
toolbar becomes a stop button and you can stop the current action. This works
|
||
by sending a signal to the process (and its child process(es)) to stop the
|
||
process. The used signal is SIGQUIT.
|
||
</p><p>
|
||
Depending on the process you started it might occur that the process cannot be
|
||
stopped. This can happen when the process creates more than one child process.
|
||
Therefore stopping any make actions is not possible because make creates child
|
||
processes and these child processes creates again child process. There might be
|
||
some other programs which cannot be stopped correctly. Xterm is known to work
|
||
properly. If you are using "Terminal" (the terminal program of Xfce), you
|
||
should add the command line option "--disable-server" otherwise the started
|
||
process cannot be stopped. Just add this option in the preferences dialog on
|
||
the Tools tab in the terminal field.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812465"></a>Set Includes and Arguments</h3></div></div></div><p>
|
||
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 use when running Execute.
|
||
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
|
||
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.
|
||
</p></div><p>
|
||
These settings are not saved when <span class="application">Geany</span> is shut
|
||
down. See below for how to set permanent arguments.
|
||
</p><p>
|
||
If you need complex settings for your build system, or several different
|
||
settings, then writing a Makefile and using the Make commands is recommended.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812506"></a>Indicators</h3></div></div></div><p>
|
||
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.
|
||
</p><p>
|
||
If you do not like this feature, you can disable it in the preferences dialog.
|
||
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2812526"></a>File type configuration settings</h3></div></div></div><p>
|
||
You can set the commands to run for compiling, building or executing
|
||
by opening the relevant <code class="filename">filetypes.*</code> configuration file,
|
||
and checking the [build_settings] section. See <a href="ch04.html#filetypes" title="Filetype definition files">the section called “Filetype definition files”</a> for more
|
||
information.
|
||
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03s09.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s11.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Project Management </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Printing support</td></tr></table></div></body></html>
|