Installation

Table of content

  1. Install as Part of KDE Software Compilation
  2. Fedora
  3. FreeBSD
  4. Linux as snap package
  5. Windows
  6. Mac OS X
  7. Source Code on Linux like operating systems
  8. Source Code on Windows
  9. Cross compile Umbrello for Windows

Install as Part of KDE Software Compilation

Umbrello is part of KDE Software Compilation which means it comes with all GNU/Linux distributions. You will be able to install it using your normal software installation app (Muon, Software Centre, Yast etc) or command line package manager (yum, up2date, yast, zypper, apt-get, emerge etc).

The package will be called umbrello, some older distros will package it as kdesdk.

Fedora

At least on fedora 20 it is also required to install the package oxygen-icon-theme, otherwise umbrello will not show any icons.

FreeBSD

Umbrello is available from FreeBSD ports.

Linux as snap package

Umbrello is available on Linux as snap package.

Windows

Umbrello installer and portable packages for 32bit and 64 bit Windows are available at the KDE download mirror network.

Please note that the KDE on Windows distribution does not contain the latest umbrello releases.

Mac OS X

Umbrello is available for Mac OS X on MacPorts.

Source Code on Linux like operating systems

The program has no platform specific code, so should compile on any system with KDE.

Here are the packages required for building Umbrello:

  • CMake
  • GNU make
  • GNU C++ compiler (g++)
  • libxslt, libxml2
  • Qt5/KF5
    • Qt >= 5.4, including development package
    • KDE frameworks development package 5.x
    On openSUSE Leap 15.1 use the following command to install required packages:
    sudo zypper in kio-devel libQt5PrintSupport-devel libqt5-qttools-devel \
       libqt5-qtsvg-devel libQt5WebKitWidgets-devel kdoctools-devel \
       kiconthemes-devel kdelibs4support-devel ktexteditor-devel
  • KDE4
    • Qt >= 4.7, including development package
    • kdelibs development package 4.8 or newer

To install from source out of git, enter the following commands in a shell:

mkdir -p $HOME/src
cd $HOME/src
git clone git://anongit.kde.org/umbrello  
cd umbrello
mkdir build
cd build

for building with Qt5/KF5 run:

cmake -DCMAKE_INSTALL_PREFIX=$HOME/umbrello -DBUILD_KF5=1 -DCMAKE_BUILD_TYPE=Debug ../

and on building for KDE4

cmake -DCMAKE_INSTALL_PREFIX=$HOME/umbrello -DBUILD_KF5=0 -DCMAKE_BUILD_TYPE=Debug ../

Check the cmake output for missing build requirements and install them

make
make install

If you are building on the basis of Qt4/KDE4 and get an error from cmake,

    "RELEASE_SERVICE_VERSION_MICRO" "GREATER_EQUAL" "70"
      Unknown arguments specified
then try commenting out the following lines in the main CMakeLists.txt file:

if (RELEASE_SERVICE_VERSION_MICRO GREATER_EQUAL 70)
    math(EXPR UMBRELLO_VERSION_MINOR "${UMBRELLO_VERSION_MINOR}-1")
endif()

Running the program from local installation

Qt5/KF5 builds in a KF5 environment

running umbrello KF5 build in a KF5 environment requires to use the following commands.

$HOME/umbrello/bin/umbrello5 &

If someone wants to add a desktop entry:

  1. Open a terminal on your desktop
  2. Create a file named umbrello.desktop
  3. Edit, paste and save

[Desktop Entry]
Categories=Application;Development;
Comment[es_ES]=Umbrello - UML Modeller
Comment=Umbrello - UML Modeller
Exec=$HOME/umbrello/bin/umbrello5
GenericName[es_ES]=Umbrello
GenericName=Umbrello
Icon=/home/<USER HOME>/umbrello/share/icons/hicolor/scalable/apps/umbrello.svgz
Name=Umbrello
StartupNotify=true
Terminal=false
X-KDE-SubstituteUID=false

Qt5/KF5 builds in a KDE4 environment

running umbrello KF5 build in a KDE4 environment requires to use the following commands.

eval `dbus-launch`
kdeinit5
$HOME/umbrello/bin/umbrello &

under a KDE4 environment

Before running umbrello, you need set the KDEDIRS environment variable with:

export KDEDIRS=$HOME/umbrello:$KDEDIRS
kbuildsycoca4

Run the following command from a shell:

$HOME/umbrello/bin/umbrello &

You may add the following commands to your .bashrc or similar login shell config file to have umbrello in the users system path:

export KDEDIRS=$HOME/umbrello:$KDEDIRS
export PATH=$HOME/umbrello/bin:$PATH

With that you can run umbrello simply by typing:

umbrello

Note: There are reports that there may be no tool bar icons after installing umbrello/KDE4 in a non default location. If this happens to you, please install an official umbrello/KDE4 version with your package manager; then start you just created umbrello.

Source Code on Windows

Umbrello could be build on windows from source with the emerge build system.

Cross compile Umbrello for Windows

Umbrello could be cross compiled for Windows from source with the help of the openSUSE Build Service (OBS) provided by the package mingw32-umbrello for 32bit builds and mingw64-umbrello for 64bit builds.

Windows installer and portable packages are provided with mingw32-umbrello-installer and mingw64-umbrello-installer.

The mentioned obs packages provide remote builds by default. Local builds are possible on any Linux system with the help of the OpenSuse command line build client and are useful to inspect and fix hidden issues happening with remote builds like non visible compiler or linker errors.