Fpcup

This is an old revision of Fpcup, edited by BigChimp at . The current revision is 94230.

/* Documentation */

About

fpcup is a tool that automates running a subversion client to build FPC and/or Lazarus in a self-contained directory structure. It is meant as a thin wrapper around the regular manual svn up/make/make install build process.

Think of it as a batch file on steroids that does the boring svn work for you.

On Windows, it can also serve as a "bare metal" installer: it can download a subversion client, binutils (make.exe etc).

fpcup allows maintaining multiple different FPC/Lazarus combinations.

It is a third party tool, not part of FPC or Lazarus.

The fpcup GUI which is provided with the source code:

Ready to run

fpcup is ready to run out of the box. It will download and install FPC and Lazarus. On Windows, this directory layout is used:

C:\development\config_lazarus # Default primary-config-path directory 
                              # (contains Lazarus settings)
C:\development\cross          # Place to store cross compiling binutils and libs if wanted
C:\development\extras         # Third party modules (see fpcup.ini) such as fpcdocs
C:\development\fpcbootstrap   # Binutils (make.exe etc) and bootstrap compiler
C:\development\fpc            # FPC fixes 2.6 by default
C:\development\lazarus        # Lazarus trunk by default

On Linux/OSX/BSD, a similar layout is used under ~

fpcup will create a shortcut to the installed Lazarus on your desktop.

Just run fpcup, e.g. on Windows:

fpcup

On *nix:

#replace fpcup_linux_x86 with your actual fpcup filename of course if not on linux x86
chmod u+rx fpcup_linux_x86 #make executable (one time only action)
./fpcup_linux_x86 #run

Next time, you can either run the exact same command, or run the fpcup_update desktop shortcut or home directory shell script/batch file.

Documentation

fpcup has

See the source code repository for the latest readme.txt and fpcup.html.

To make it easier to get user contributions for documentation/tips, this wiki page has been created. Please feel free to add your own examples etc.

Tips

Anchordocking

One way to enable anchordocking is by using settings.ini: open your settings file or add a new file settings.ini

[anchordocking]
; Just a plain install except enable anchordocking package
anchordocking=1

This will use default settings but also enable the anchordocking package in the IDE.

Of course, you can use the anchordocking=1 module setting in any .ini section.

Building only FPC

You can build FPC without Lazarus if you want (or the other way round). The example below builds FPC from the fixes 2.6 SVN branch.

Settings

Open your settings file or add a new file, settings.ini:

[fixes26]
; FPC 2.6 fixes only (no Lazarus)
fpcdir=c:\development\fpcfixes26
fpcurl=http://svn.freepascal.org/svn/fpc/branches/fixes_2_6
; Let's specify Lazarus info in case we ever want to add lazarus
lazdir=c:\development\lazarus12_fixes26
; Just an example: build Lazarus 1.2:
lazurl=http://svn.freepascal.org/svn/lazarus/tags/lazarus_1_2
primary-config-path=c:\development\configlazarus12_fixes26
; If we ever build Lazarus, do create a link/shortcut:
lazlinkname=lazarus12_fixes26
; Do not create a batch file with shortcut
fpcuplinkname=""
; We can use the binutils/bootstrap dirs that we usually use:
binutilsdir=c:\development\fpcbootstrap
fpcbootstrapdir=c:\development\fpcbootstrap
; Just install/update, no questions asked:
noconfirm=true
; In case you want to submit patches, it's nice to be able to update
; without overwriting your fixes:
keeplocalchanges=true
; Specify we only want FPC, not Lazarus
; in case of fpc patches FPCBuildOnly
only=FPC,FPCCrossWin32-64
skip=helplazarus,lazarus,lazbuild,bigide,useride

Then get FPC and build it with:

fpcup --inifile=settings.ini --inisection=fixes26

Now you can run your compiler:

c:\development\fpcfixes26\bin\i386-win32\fpc.exe -h

Cross-compile for win64, e.g.:

c:\development\fpcfixes26\bin\i386-win32\fpc.exe -Px86_64 yourfile.pas

Avoid lengthy lcl.chm documentation generation

By default, fpcup tries to compile the $(lazarusdir)\docs\chm\lcl.chm Lazarus help file every day or so. This can take a long time due to the fpdoc tool being quite slow.

You can avoid compiling lcl.chm by generating it one time (or copying over an existing file) and making the file read-only.

Cross compilers

fpcup not only lets you install native FPC/Lazarus, but will also build cross compilers for you.

For most cross compilers, you do need to have the relevant binutils that are specific for the host<>target system.

Often, you will also need libraries in target system format if you want to compile programs (e.g. Linux Qt or Gtk libraries for the relevant CPU if you're crosscompiling for Linux).

When you run a crosscompiler, fpcup briefly checks if it can find required binutils and libraries and will warn you if they can't be found.

Status

From\To DOS GO32v2 Windows x86 Windows x64 Linux x64 Linux x86 Linux mipsel Linux arm Android ARM FreeBSD x64 FreeBSD x86 OSX AIX powerpc32
Any needs binutils,libs needs binutils,libs needs binutils,libs needs binutils,libs
Windows x86 needs FPC trunk, binutils yes, built in N/A yes needs binutils,libs needs binutils,libs see Any see Any See Any
Windows x64 no needs binutils yes N/A needs binutils,libs needs binutils,libs see Any see Any See Any
Linux x64 no yes, built in N/A see Any see Any no plans no plans See Any
Linux x86 yes, built in N/A see Any see Any no plans no plans See Any
Linux mipsel N/A see Any See Any
Linux arm see Any N/A See Any
Android ARM see Any see Any N/A See Any
FreeBSD x64 no no plans yes, built in see Any see Any N/A See Any
FreeBSD x86 no plans yes, built in see Any see Any N/A See Any
OSX verify see Any see Any N/A See Any
AIX powerpc32 see Any see Any N/A

(With thanks to FPSpreadsheet's spreadsheet to wikitable conversion tool, see e.g. examples\fpsgrid)

AIX PowerPC crosscompiler

Once you have set up a regular FPC trunk/2.7.1 compiler, you can add an FPC AIX Port cross compiler.

Limitations:

Required files

Settings

Open your settings file or add a new file, settings.ini:

[aix]
; AIX on powerpc32 cross compiler. Also runs on 64 bit powerpc
; a full fpcup run must have been done before
; please adjust paths etc
fpcdir=c:\development\fpctrunk
fpcurl=http://svn.freepascal.org/svn/fpc/trunk
fpcopt=""
fpcuplinkname=""
lazlinkname=""
binutilsdir=c:\development\fpcbootstrap
fpcbootstrapdir=c:\development\fpcbootstrap
noconfirm=true
keeplocalchanges=true
cputarget=powerpc
fpcopt=""
crossopt=""
ostarget=aix
; Perhaps best to always clean... can be removed for speed
only=FPCCleanOnly,FPCBuildOnly
skip=FPCGetOnly,lazbuild,bigide,useride

See also:

Creating and using the cross compiler

Then generate the cross compiler with

fpcup --inifile=settings.ini --inisection=aix

If, like me, you don't have the libs from the target platform and run with --verbose, you'll see something like:

C:\development\cross\bin\powerpc-aix\powerpc-aix-ld.exe: cannot find \lib\crt0.o
C:\development\cross\bin\powerpc-aix\powerpc-aix-ld.exe: cannot find -lm
C:\development\cross\bin\powerpc-aix\powerpc-aix-ld.exe: cannot find -lc
C:\development\cross\bin\powerpc-aix\powerpc-aix-ld.exe: cannot find -lbsd

If the compiler generation went ok, you can run a test compile, compiling a file test.pas with

fpc -Ppowerpc -Taix -CN test.pas

(your fpc.cfg will have been modified to add some settings when cross-compiling to Android ARM)

Android ARM crosscompiler

Once you have set up a regular FPC trunk/2.7.1 compiler, you can add an Android cross compiler.

Limitations:

Required files

Download the Android NDK (e.g. a file like android-sdk_r22.3-windows.zip) for your platform and extract the crossbinutils, e.g. from a path like

android-ndk-r9c\toolchains\arm-linux-androideabi-4.8\prebuilt\windows-x86_64\bin

The result is something like these files (adjust for your platform etc):

arm-linux-androideabi-addr2line.exe
arm-linux-androideabi-ar.exe
arm-linux-androideabi-as.exe
arm-linux-androideabi-c++.exe
arm-linux-androideabi-c++filt.exe
arm-linux-androideabi-cpp.exe
arm-linux-androideabi-elfedit.exe
arm-linux-androideabi-g++.exe
arm-linux-androideabi-gcc-4.8.exe
arm-linux-androideabi-gcc-ar.exe
arm-linux-androideabi-gcc-nm.exe
arm-linux-androideabi-gcc-ranlib.exe
arm-linux-androideabi-gcc.exe
arm-linux-androideabi-gcov.exe
arm-linux-androideabi-gdb-orig.exe
arm-linux-androideabi-gdb.exe
arm-linux-androideabi-gprof.exe
arm-linux-androideabi-ld.bfd.exe
arm-linux-androideabi-ld.exe
arm-linux-androideabi-ld.gold.exe
arm-linux-androideabi-ld.mcld.exe
arm-linux-androideabi-nm.exe
arm-linux-androideabi-objcopy.exe
arm-linux-androideabi-objdump.exe
arm-linux-androideabi-ranlib.exe
arm-linux-androideabi-readelf.exe
arm-linux-androideabi-size.exe
arm-linux-androideabi-strings.exe
arm-linux-androideabi-strip.exe

Put these files in your cross binutils directory for the right platform - e.g. on a standard Windows fpcup install:

C:\development\cross\bin\arm-android

Libs: extract the libs from a path like

android-ndk-r9c\platforms\android-19\arch-arm\usr\lib

into

C:\development\cross\lib\arm-android

The libs in question can be like this list:

crtbegin_dynamic.o
crtbegin_so.o
crtbegin_static.o
crtend_android.o
crtend_so.o
libandroid.so
libc.a
libc.so
libdl.so
libEGL.so
libGLESv1_CM.so
libGLESv2.so
libGLESv3.so
libjnigraphics.so
liblog.so
libm.a
libm.so
libm_hard.a
libOpenMAXAL.so
libOpenSLES.so
libstdc++.a
libstdc++.so
libthread_db.so
libz.so
rs

Settings

Open your settings file or add a new file, settings.ini:

[android]
; Android ARM cross compiler
; a full fpcup run must have been done before
; please adjust paths etc
fpcdir=c:\development\fpctrunk
fpcurl=http://svn.freepascal.org/svn/fpc/trunk
fpcopt=""
fpcuplinkname=""
lazlinkname=""
binutilsdir=c:\development\fpcbootstrap
fpcbootstrapdir=c:\development\fpcbootstrap
cputarget=arm
ostarget=android
; You can specify exact instruction set and floating point support etc:
crossopt="-CpARMV7 -CfVFPV3"
; ... or something more conservative/compatible:
;crossopt="-CpARMV6"
verbose=0
; We only need an FPC here; assume FPC has been updated by regular update
only=FPCBuildOnly
; No LCL support on Android yet

See also:

Creating and using the cross compiler

Then generate the cross compiler with

fpcup --inifile=settings.ini --inisection=android

Now you can run a test compile, compiling a file test.pas with

fpc -Parm -Tandroid test.pas

(your fpc.cfg will have been modified to add some settings when cross-compiling to Android ARM)

Linux ARM cross compiler

Once you have set up a regular FPC compiler, you can add an Linux on ARM cross compiler (e.g. for a Raspbian/Raspberry Pi).

Required files

C:\development\cross\lib\arm-linux

On Windows, the result is something like these files (adjust for your platform etc):

arm-linux-addr2line.exe
arm-linux-ar.exe
arm-linux-as.exe
arm-linux-ld.exe
arm-linux-objcopy.exe
arm-linux-objdump.exe
arm-linux-strip.exe

Libs: extract the libs from your device - e.g. this on Raspbian:

Note: some .so files are actually scripts; check

grep -i "ld script" *

Remove those .so and copy over (or symlink) the .so.x to .so in order for the linker to find them Examples: libpthread.so libc.so libgcc_s.so

put them into your cross lib path, e.g. on Windows

C:\development\cross\lib\arm-linux

Settings

Open your settings file or add a new file, settings.ini.

As you can see in the comments below, you can build an ARMHF cross-compiler which works on e.g. Raspbian, requires an FPU and requires ARMHF libraries, but only on FPC 2.7+.

[linuxarm]
; a full fpcup run must have been done before (e.g. win32full)
; does not update packages
; please adjust paths etc
fpcdir=c:\development\fpctrunk
fpcurl=http://svn.freepascal.org/svn/fpc/trunk
lazdir=lazdir=c:\development\lazarus
primary-config-path=c:\development\lazarussettings
lazlinkname=""
fpcuplinkname=""
; NO FPIC: not supported on 2.6.x
; http://bugs.freepascal.org/view.php?id=19729
; otherwise Fatal: Internal error 200502052
; If using -CaEABIHF in crossopt, specify -dFPC_ARMHF here (only works on 2.7.x)
; more info see below
fpcopt=""
binutilsdir=c:\development\fpcbootstrap
fpcbootstrapdir=c:\development\fpcbootstrap
noconfirm=true
keeplocalchanges=true
cputarget=arm
; if using armhf, you MUST specify -dFPC_ARMHF in the FPC options; 
; specifying in crossopt is not enough.
; -fPIC not supported on FPC 2.6.x, only on 2.7.x; 
fpcopt="-dFPC_ARMHF"

; safe default but slow:
;crossopt="-CpARMV6 -CaEABI -CfSOFT"

; Raspbian for Raspberry Pi safe
; ARMv6 instruction set
; if using arm hf (hard float/floating point), please specify -dFPC_ARMHF
; copy over /lib, /usr/lib 
; /usr/lib/arm-linux-gnueabihf (Raspbian) => note: 
; some .so files are actually scripts; check
; grep -i "ld script" *
; Remove those .so and copy over (or symlink) the .so.x to .so in order for the linker to find them
; Examples:
; libpthread.so
; libc.so
; libgcc_s.so
; to cross lib dir (try compiling and keep copying until no errors left)
; Note: -CpARMV6Z parameter not supported on 2.6.x, only on 2.7.x
; Note: -CaEABIHF parameter not supported on 2.6.x, only on 2.7.x
; Note: don't use -fPIC; will give segmentation fault
crossopt="-CaEABIHF -CpARMV6 -CfVFPV2"

; beagleboard black with hardfloat:
; if using armhf, also specify -dFPC_ARMHF (in fpcopt) to avoid gtk scrollbar errors
; Note: -CaEABIHF not supported on 2.6.x, only on 2.7.x
;crossopt="-CaEABIHF -Cparmv7 -CfVFPv3"
ostarget=linux
; we only need to do Lazarus as FPC won't change here
only=FPCCleanOnly,FPCBuildOnly
skip=FPCGetOnly,lazbuild,bigide,useride

See also:

Creating and using the cross compiler

Then generate the cross compiler with

fpcup --inifile=settings.ini --inisection=linuxarm

Now you can run a test compile, compiling a file test.pas with

fpc -Parm -Tlinux test.pas

(your fpc.cfg will have been modified to add some settings when cross-compiling to Android ARM)

DOS crosscompiler

Using 32 bit fpcup.exe on Windows, once you have set up a regular FPC trunk/2.7.1 compiler, you can add a DOS cross compiler.

Required files

Download the required binaries as mentioned in DOS, currently:

msdos-nasm.exe
msdos-wlib.exe
msdos-wlink.exe
nasm.exe
wlibd.dll
wlinkd.dll
wlsystem.lnk

and put them in your cross binutils directory for the right platform - e.g. on a standard Windows fpcup install:

c:\development\cross\bin\i8086-msdos

There are no files needed in the corresponding library directory,

C:\development\cross\lib\i8086-msdos

Settings

Open your settings file or add a new file, settings.ini:

[dos]
; dos cross compiler
; a full fpcup run must have been done before
; please adjust paths etc
fpcdir=c:\development\fpctrunk
fpcurl=http://svn.freepascal.org/svn/fpc/trunk
fpcopt=""
fpcuplinkname=""
lazlinkname=""
binutilsdir=c:\development\fpcbootstrap
fpcbootstrapdir=c:\development\fpcbootstrap
cputarget=i8086
ostarget=msdos
verbose=0
; We only need an FPC here; assume FPC has been updated by regular update
only=FPCBuildOnly

Creating and using the cross compiler

Then generate the cross compiler with

fpcup --inifile=settings.ini --inisection=dos

Now you can run a test compile, compiling a file test.pas with

fpc -Pi8086 -TMSDOS test.pas

(your fpc.cfg will have been modified to use DOS medium memory model, smartlinking etc)

Download

The official site is at: https://bitbucket.org/reiniero/fpcup/downloads

License

fpcup is open source software released under the LGPL with linking exception (same as FreePascal/LCL).

Troubleshooting

When you hit errors with fpcup:

svn revert THEDIRECTORY --recursive

followed by

svn update THEDIRECTORY

for your Lazarus and FPC directories to remove local modifications, if any.

If the steps before do not work: you can use the --uninstall option to remove all files including your FPC and Lazarus directories, then run fpcup with the same commands.

Of course, errors introduced in FPC and Lazarus source code/repository may also influence builds. There's nothing fpcup can do to fix incorrect code breaking the build. However, some of the steps mentioned above (deleting .ppu files, fpc.cfg, Lazarus config) may fix Lazarus/FPC build problems..

Known issues

Known issues can be found in the issue tracker: https://bitbucket.org/reiniero/fpcup/issues?status=new&status=open

Strange errors running clean/distclean

This is a symptom of issues with the FPC build system (not fpcup).

On Windows, make 3.80 which is distributed with FPC 2.6.x has problems when there are spaces in your path. This may lead to strang error messages when cleaning. Solution: download make 3.81 or make 3.82. Make 3.82 is newer, but cannot build FPC 2.6.x; it builds FPC 2.7.x fine, though.

Info: Error running fpcup. Technical details: error executing sequence helplazarus; line: 4, param: helplazarus

HelpLazarus is often the first module that will be built after building lazbuild and the other core IDE units. However, the actual problem may be that lazbuild itself was not generated due to an error. Try running with --verbose to pinpoint where the problem is and follow the troubleshooting steps above.

Error finding (e.g.) system.ppu when compiling with FPC/Lazarus

Try running Tools > Rescan FPC Source Directory

Errors like this may be caused by an fpc.cfg from an older/different version of FPC that remains in your fpc/bin/<platform> directory. Because you can customise fpc.cfg, fpcup will not just replace it.

If you have not customised fpc.cfg, you can remove it and let fpcup regenerate it when rebuilding FPC.

Support and bug reporting

Please post support requests on the forum (e.g. in the thread dedicated to FPCUP in the Third-Party announcements section).

If you report problems, after running the troubleshooting steps above, please be sure to mention:

  1. operating system
  2. fpcup version (as printed in its output)
  3. description of what went wrong/error message
  4. run fpcup with the --verbose --noconfirm arguments (or the equivalents in settings.ini) as well as the other arguments you used, redirect the output to file, and attach the file, e.g.:
fpcup --verbose --noconfirm > fpcupverbose.txt

if you post on the forum, please zip it and attach the result to your post

Current progress

Changelog

This log tracks fpcup binaries as available on the download page. Note that not all binaries may be updated at the same time; fpcup prints a version string at the beginning which you can check.

For more details, please see the Mercurial commit log in https://bitbucket.org/reiniero/fpcup/commits/all

Snippet format changed: PLEASE REMOVE ALL # fpcup do not remove snippets from fpc.cfg or entire fpc.cfg and rerun your cross compilers.

Earlier releases: please see the fpcup forum thread

See also