Preparation

Table of Contents

• Source
• Build system
  • all (= default)
  • install
  • pot
  • doc
  • package
• Tools

This chapter describes how to get fbdbg working on your system.

Source

The FreeBASIC debugger source code is located at fbdebugger. You need the GIT version control system installed on your system in order to download the source tree.

Once you get GIT working, go to the folder where you want the source tree of fbdebugger to be installed and type

cd /folder/to/location
git clone https://github.com/fbdebugger/fbdebugger.git

You'll get a new subfolder named fbdebugger containing the source code, the documentation texts and auxiliary files (there's no executable).

Build system

The build system is based on CMake. It supports in-source and out-of-source builds. The later is recommended, in order to keep the source tree clean and allow multiple builds in separate build trees without interferences to the other build trees (no need for clearing the build tree for a different build target).

In order to create your build tree, first create a new folder for that tree and change to that folder. Then let CMake generate the makefiles (the example assumes that you start from the directory where you executed the git command from section Source )

mkdir fbdbg_build
cd fbdbg_build
cmake ../fbdbg

You'll find a bunch of directories and files generated by CMake, or copied from the source tree (necessary to test the executable in the build tree).

Now, several make targets are available in the build tree

• all (= default)
• install
• pot
• doc
• package

Note

Some of the targets may not be available, due to missing tools on your system. Find that information in the output of the above commands. Section Tools explains the purpose of the tools and how to install them.

all (= default)

To compile the source and generate an executable, execute

make

That creates the executable in the fbdbg_build folder, which you can start and test.

Note

This target needs the FreeBASIC compiler and the GTK+ development libraries to be installed on your system.

install

This target installs the executable and all auxiliary files on you system. Just type

sudo make install

pot

This target re-creates the file src/fbdbg.pot containing all strings for the translators. It scans the FB source code and the GUI description files (*.ui) and extracts the translatable string contexts. Translators use this file to update their translation files in order to update them.

make pot

This file is independant from any build target, and therefor gets created in the source tree.

Note

This target needs xgettext to be installed on your system.

doc

This target creates the documentation in form of a html tree and a directory of LaTeX files. Both folders are is independant from any build target, and therefor get created in the source tree.

sudo make install

The html tree is ready for use, just load the file doc/html/index.html in to your browser.

Note

This target needs Doxygen, graphviz and fb-doc to be installed on your system.

Todo:

The doc/latex folder contains a makefile, just execute the make command in the folder to use pdftex for creating the file refman.pdf.

Note

Creating the pdf file needs LaTeX to be installed on your system.

package

This target creates the ???

Tools

Find information about the tools used in the above make targets in this section.

...