Difference between revisions of "KTp/Getting Set Up"

< KTp
Jump to: navigation, search
m
m (Using an existing kdesrc-build)
 
(73 intermediate revisions by 18 users not shown)
Line 1: Line 1:
These instructions assume that you already know how to build KDE stuff from source. It just provides a list of what you need to checkout and build, and how to run it.
+
These instructions assume that you already know how to build KDE stuff from source. Check the "[http://techbase.kde.org/Getting_Started/Build/KDE_Applications building KDE applications page]" for more help with that.  The rest of this page will just tell you what to build and where to get it from.
  
 
==Prerequisites==
 
==Prerequisites==
  
You will also need to install several cross-desktop Telepathy components. Packages of the following from your distribution should do fine.
+
You will need KDE 4.10 or 4.9. We do not require latest git KDE.
 +
 
 +
You will need to install several cross-desktop Telepathy components. Packages of the following from your distribution should do fine.
 
* telepathy-mission-control-5
 
* telepathy-mission-control-5
* telepathy-gabble (for Jabber support)
+
* telepathy-gabble for Jabber, GTalk and Facebook Chat support
 
* other Telepathy connection managers if you want to try out other protocols
 
* other Telepathy connection managers if you want to try out other protocols
 +
** telepathy-haze for icq, msn, yahoo, aim and all the others that Pidgin/libpurple supports
 +
** telepathy-rakia for sip
 +
* telepathy-logger (for the contact list)
 +
* kdepimlibs (devel packages; for kpeople)
  
You will also need to follow the steps 'Let Git rewrite URL prefixes' listed here, if you have not done so already.:
 
http://community.kde.org/Sysadmin/GitKdeOrgManual#Let_Git_rewrite_URL_prefixes
 
 
==TelepathyQt4==
 
 
The prerequisite for all the Telepathy stuff to build is the TelepathyQt4 library. The source code for this is available [http://cgit.freedesktop.org/telepathy/telepathy-qt4/ here]. Your distribution may package it, in which case you need version >= 0.7.1. Be careful not to confuse it with the telepathy-qt library which used to be in kdesupport SVN. This is *completely* different and in no way compatible.
 
 
If you are compiling Tp-Qt4 and get a warning about needing a newer glib, simply ignore it. Glib is only needed for some internal Tp-Qt4 tests.
 
 
If you are building your own copy of TelepathyQt4, clone the git repository linked above and use the usual cmake method to build and install it.
 
 
==The parts ready for testing==
 
 
Please fetch these, and file bugs on any required missing features or problems. Keep things realistic on the feature requests.
 
 
===Telepathy Accounts KCM===
 
 
The next thing to get set up is the Telepathy Accounts KCM. This is the UI for account management.
 
 
Source code is [https://projects.kde.org/projects/playground/network/telepathy/telepathy-accounts-kcm/ here].
 
 
<code>git clone kde:telepathy-accounts-kcm</code>
 
 
This can be compiled and installed by the usual KDE build procedure.
 
 
You will also want the plugins for this app, found at [https://projects.kde.org/projects/playground/network/telepathy/telepathy-accounts-kcm/telepathy-accounts-kcm-plugins here].
 
 
<code>git clone kde:telepathy-accounts-kcm-plugins</code>
 
 
===Contact List App===
 
 
This application provides a traditional contact-list, similar to the one provided by Kopete. Code is in git [https://projects.kde.org/projects/playground/network/telepathy/telepathy-contact-list here]
 
 
<code>git clone kde:telepathy-contact-list</code>
 
 
===Chat window App===
 
 
This application provides a text chat window.
 
 
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-chat-handler KDE Project Page]
 
 
<code>git clone kde:telepathy-chat-handler</code>
 
 
===The approver===
 
 
This notifies you when an incoming message arrives and hangs in the system tray until you're ready to start a chat.
 
 
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-approver/ KDE Project Page]
 
 
<code>git clone kde:telepathy-approver</code>
 
 
===Presence Plasmoid and Dataengine===
 
 
This shows the online-ness of your accounts and allows to bring accounts online/offline
 
 
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-presence-applet/ KDE Project Page]
 
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-presence-dataengine/ KDE Project Page]
 
 
<code>
 
git clone kde:telepathy-presence-applet
 
</code>
 
 
<code>
 
git clone kde:telepathy-presence-dataengine
 
</code>
 
  
===The File Transfer Handler===
+
You will also need to follow the steps to [[Sysadmin/GitKdeOrgManual#Let_Git_rewrite_URL_prefixes|setup the kde: prefix in Git]], if you have not done so already.
  
Does the actual transferring of files between two contacts. Displays progress via KJob
+
=== QtGstreamer ===
  
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-filetranser-handler/ KDE Project Page]
+
In order to build the [[#Call window App|call window application]], you will need the [http://gstreamer.freedesktop.org/modules/qt-gstreamer.html Qt bindings for GStreamer].  Your distribution will probably provide packages, or you can build from git:
 +
<syntaxhighlight lang="bash">
 +
git clone git://anongit.freedesktop.org/gstreamer/qt-gstreamer
 +
</syntaxhighlight>
  
<code>git clone kde:telepathy-filetranser-handler</code>
+
=== Ubuntu build deps ===
  
=== Dolphin Integration ===
+
While using some Ubuntu distributions you would like to have these packages installed (they are critical to build Ktp on your machine) from apt:
  
Allows you to start a file transfer via a handy shortcut in your file manager.
+
<syntaxhighlight lang="bash">
 +
sudo apt-get install doxygen graphviz libfarstream-0.1-dev libgstreamer-plugins-base0.10-dev libgstreamer0.10-dev libqt4-dev libtelepathy-farstream-0.4-dev libtelepathy-glib-dev pkg-config cmake debhelper kdelibs5-dev libtelepathy-logger-dev libtelepathy-logger-qt4-dev libtelepathy-qt4-dev pkg-kde-tools bison cmake flex libqt4-dev libqtgstreamer-dev libtelepathy-glib-dev libtelepathy-logger-dev libxml2-dev python python-dev libxml-parser-perl librpc-xml-perl libqjson-dev libqca2-dev libqca2-plugin-ossl kdepim-dev libqtwebkit-dev
 +
</syntaxhighlight>
  
[https://projects.kde.org/projects/playground/network/telepathy/telepathy-send-file/ KDE Project Page]
+
=== Arch build deps ===
  
<code>git clone kde:telepathy-send-file</code>
+
<syntaxhighlight lang="bash">
 +
sudo pacman -S perl-libwww perl-json perl-xml-parser boost
 +
</syntaxhighlight>
  
==The bits that might work for you, but might not==
+
==Recommended installation==
 +
This method is based on a scratch of David Edmundson which is located [http://quickgit.kde.org/?p=scratch%2Fdavidedmundson%2Fktp-bootstrap.git here]. You may pull it on your local machine and run '''install.sh'''. Before going forward, make sure that you have configured your Git configuration file for KDE prefix, if not follow [https://community.kde.org/Sysadmin/GitKdeOrgManual#Let_Git_rewrite_URL_prefixes this]:
  
These parts might work for you - it's worth installing but don't start filing bugs yet.
+
<syntaxhighlight lang="bash">
 +
git clone git://anongit.kde.org/scratch/davidedmundson/ktp-bootstrap.git
 +
cd ktp-bootstrap
 +
sh install.sh
 +
</syntaxhighlight>
  
===QtGstreamer===
 
  
Not part of KDE Telepathy but needed to compile the call window app
+
As soon as your installation has finished you can start Ktp by choosing '''Instant Messaging Contact List''' from the menu of your system. Alternatively, you may want to discover source yourself, e.g. if you are planning to contribute. Then, you can go path '''~/ktp/src/ktp-contact-list''' (git repository is already set there!)
  
<code>git clone git://gitorious.org/qtgstreamer/qtgstreamer.git</code>
+
===Making Changes===
  
(packages also available for ubuntu at https://launchpad.net/~gstreamer-developers/+archive/ppa)
+
When you first open kdevelop for the first time select the CMakeLists file in ~/ktp/src/<project>/CMakeLists.txt when asked to specify the build directory select ~/ktp/build/<project>/ NOT the default option.
  
===Call window App===
+
This will mean kdevelop will use your existing install set up and environment and any installations will be kept local.
  
This application provides a voice/video chat window (optional). Code is in git [https://projects.kde.org/projects/playground/network/telepathy/telepathy-call-ui here].
+
If you are ever prompted for your root password for installations you are doing something wrong.
  
<code>git clone kde:telepathy-call-ui</code>
+
===Updating===
  
 +
Run ./update-ktp from your ~/ktp directory.
  
 +
For extra functionality and arguments please read http://kdesrc-build.kde.org/documentation/
  
 +
== Using an existing kdesrc-build ==
  
 +
To use kdesrc-build to build KDE Telepathy type
  
==The other bits==
+
kdesrc-build extragear/telepathy
  
===Shared desktop ontologies===
+
It may be desirable to also build TelepathyQt, which can be done by adding the following module
  
<code>git clone git://oscaf.git.sourceforge.net/gitroot/oscaf/shared-desktop-ontologies</code>
+
module telepathy-qt
 +
    repository git://anongit.freedesktop.org/telepathy/telepathy-qt4
 +
    branch master
 +
end module
  
===KDE Telepathy library : libktelepathy===
 
  
NOTE: git master probably won't compile.
+
Because we rely on dbus activation we need to make sure our files are in the XDG dbus paths /when dbus loads/.
  
Source code is [https://projects.kde.org/projects/playground/network/telepathy/telepathy-kde/repository/ here].
+
there are two ways to do this; either copy/link these dbus files to /usr/share/dbus-1/ or make sure XDG paths are set immediately at login, such as adding them in /etc/profile.d.
  
<code>git clone kde:telepathy-kde</code>
+
==Troubleshooting==
  
This can be compiled and installed by the usual KDE build procedure.
+
If you have both qt4 and qt5 installed, you may need tell kdesrc-build to use qt4 by including the following in the relevant kdesrc-buildrc (global section):
  
===Integration Daemon / Nepomuk Service===
+
<syntaxhighlight lang="cmake">
 +
cmake-options -DQT_QMAKE_EXECUTABLE=/usr/bin/qmake-qt4
 +
</syntaxhighlight>
  
NOTE: git master probably won't compile.
 
  
The Nepomuk service obsoletes the daemon and integrates Telepathy with Nepomuk, which is required by the Contact List application. Code is in git [https://projects.kde.org/projects/playground/network/telepathy/telepathy-nepomuk-service here]
+
Similarly, if you have both Python 3 and Python 2 installed, you may need to point to the python2 path:
  
<code>git clone kde:telepathy-nepomuk-service</code>
+
<syntaxhighlight lang="cmake">
 +
cmake-options  -DPYTHON_EXECUTABLE=/usr/bin/python2
 +
</syntaxhighlight>

Latest revision as of 17:53, 23 June 2014

These instructions assume that you already know how to build KDE stuff from source. Check the "building KDE applications page" for more help with that. The rest of this page will just tell you what to build and where to get it from.

Prerequisites

You will need KDE 4.10 or 4.9. We do not require latest git KDE.

You will need to install several cross-desktop Telepathy components. Packages of the following from your distribution should do fine.

  • telepathy-mission-control-5
  • telepathy-gabble for Jabber, GTalk and Facebook Chat support
  • other Telepathy connection managers if you want to try out other protocols
    • telepathy-haze for icq, msn, yahoo, aim and all the others that Pidgin/libpurple supports
    • telepathy-rakia for sip
  • telepathy-logger (for the contact list)
  • kdepimlibs (devel packages; for kpeople)


You will also need to follow the steps to setup the kde: prefix in Git, if you have not done so already.

QtGstreamer

In order to build the call window application, you will need the Qt bindings for GStreamer. Your distribution will probably provide packages, or you can build from git:

git clone git://anongit.freedesktop.org/gstreamer/qt-gstreamer

Ubuntu build deps

While using some Ubuntu distributions you would like to have these packages installed (they are critical to build Ktp on your machine) from apt:

sudo apt-get install doxygen graphviz libfarstream-0.1-dev libgstreamer-plugins-base0.10-dev libgstreamer0.10-dev libqt4-dev libtelepathy-farstream-0.4-dev libtelepathy-glib-dev pkg-config cmake debhelper kdelibs5-dev libtelepathy-logger-dev libtelepathy-logger-qt4-dev libtelepathy-qt4-dev pkg-kde-tools bison cmake flex libqt4-dev libqtgstreamer-dev libtelepathy-glib-dev libtelepathy-logger-dev libxml2-dev python python-dev libxml-parser-perl librpc-xml-perl libqjson-dev libqca2-dev libqca2-plugin-ossl kdepim-dev libqtwebkit-dev

Arch build deps

sudo pacman -S perl-libwww perl-json perl-xml-parser boost

Recommended installation

This method is based on a scratch of David Edmundson which is located here. You may pull it on your local machine and run install.sh. Before going forward, make sure that you have configured your Git configuration file for KDE prefix, if not follow this:

git clone git://anongit.kde.org/scratch/davidedmundson/ktp-bootstrap.git
cd ktp-bootstrap
sh install.sh


As soon as your installation has finished you can start Ktp by choosing Instant Messaging Contact List from the menu of your system. Alternatively, you may want to discover source yourself, e.g. if you are planning to contribute. Then, you can go path ~/ktp/src/ktp-contact-list (git repository is already set there!)

Making Changes

When you first open kdevelop for the first time select the CMakeLists file in ~/ktp/src/<project>/CMakeLists.txt when asked to specify the build directory select ~/ktp/build/<project>/ NOT the default option.

This will mean kdevelop will use your existing install set up and environment and any installations will be kept local.

If you are ever prompted for your root password for installations you are doing something wrong.

Updating

Run ./update-ktp from your ~/ktp directory.

For extra functionality and arguments please read http://kdesrc-build.kde.org/documentation/

Using an existing kdesrc-build

To use kdesrc-build to build KDE Telepathy type

kdesrc-build extragear/telepathy

It may be desirable to also build TelepathyQt, which can be done by adding the following module

module telepathy-qt
    repository git://anongit.freedesktop.org/telepathy/telepathy-qt4
    branch master
end module


Because we rely on dbus activation we need to make sure our files are in the XDG dbus paths /when dbus loads/.

there are two ways to do this; either copy/link these dbus files to /usr/share/dbus-1/ or make sure XDG paths are set immediately at login, such as adding them in /etc/profile.d.

Troubleshooting

If you have both qt4 and qt5 installed, you may need tell kdesrc-build to use qt4 by including the following in the relevant kdesrc-buildrc (global section):

cmake-options -DQT_QMAKE_EXECUTABLE=/usr/bin/qmake-qt4


Similarly, if you have both Python 3 and Python 2 installed, you may need to point to the python2 path:

cmake-options  -DPYTHON_EXECUTABLE=/usr/bin/python2

This page was last edited on 23 June 2014, at 17:53. Content is available under Creative Commons License SA 4.0 unless otherwise noted.