Quassel IRC - Installation Notes
================================
-These are preliminary instructions, until we get the config more
-polished.
+These should help you to install Quassel IRC from source. Please also have a
+look at the README file!
Quassel IRC provides three binaries: quasselcore, quasselclient, and
quassel. While quasselcore and quasselclient obviously provide the
separated core and client functionality, the latter one (quassel) is a
monolithic version containing both of them for convenience.
-To build Quassel IRC, cd to build/ and run qmake && make. This
-builds all three versions of Quassel. You may choose individual
-targets by setting qmakes BUILD variable:
+Note that quasselcore is no longer being built by default, since it tends to
+confuse users more than it helped. It will be back as soon as we have simple mode
+implemented.
-qmake BUILD=<foo>
+We now use CMake as our build system. CMake supports and encourages out-of-source
+builds, which do not clutter the source directory. You can (and should) thus use
+an arbitrary directory for building.
-where <foo> is any combination of qtclient, core, mono or all. Note
-that in order to change this later, you will have to make distclean,
-otherwise the BUILD setting seems to be ignored by qmake.
+There is no "make distclean"; "make clean" should usually be enough since CMake
+actually cleans up properly (qmake often didn't). If you really want to get rid
+of all build files, just remove the build directory.
-After running make, you will find the binaries in build/targets.
+Usually, you will build Quassel as follows:
-make install will probably do something, but it has never been tried
-and may destroy your system or kill a kitten. It's not necessary
-anyway, since there are no installable files other than the
-binaries. Though this might change in later releases.
+cd /path/to/build/dir
+cmake /path/to/quassel
+make
-On first run of the Quassel core, it will wait for a client to connect
-and present a wizard that will allow you to create the database and one
-admin user for the core-side storage. Note that Quassel does not support
-the administration of user accounts yet, this includes adding more users,
-changing passwords and so on.
+Additionally, you may add some options to the cmake call, prefixed by -D. These need
+to follow the source directory PATH:
-Please also do read the README file.
+cmake /path/to/quassel -D<option1> -D<option2>
-Thanks,
-~ The Quassel IRC Team
+NOTE: In order to reconfigure, you need to remove CMakeCache.txt (or empty
+ the build directory), otherwise cmake will ignore modified -D options!
+
+Quassel recognizes the following options:
+
+-DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF)
+ Allow to choose which Quassel binaries to build.
+
+-DQT=/path/to/qt
+ Use a non-system Qt installation. This is for example useful if you have a static
+ Qt installed in some local dir.
+
+-DSTATIC=1
+ Enable static building of Quassel. You should link the static versions of some libs
+ (in particular libstdc++.a) into /path/to/build/dir/staticlibs in oder to create
+ a portable binary!
+
+BUILDING ON WINDOWS:
+--------------------
+We have tested building on Windows with a statically built Qt (with its /bin directory in %PATH%)
+and MSVC 2005/2008. Make sure that you use a "shell" that has all needed env variables setup,
+such as the "Visual Studio Command Prompt". You will also need the /bin of the Microsoft SDK in
+your %PATH% at least for VS 2008, otherwise rc.exe is not found.
+Currently, only building in the shell using nmake seems to work; CMake can also create MSVC project
+files, but they seem to be problematic. However, YMMV. Software development on Windows is a real
+PITA.
+
+After you have everything setup:
+
+cd C:\path\to\quassel-build
+cmake -G"NMake Makefiles" C:\path\to\quassel\source -DSTATIC=1
+nmake
Quassel IRC Mobile Edition - Installation Notes
===============================================
+NOTE: QuasselTopia is currently broken. You will not be able to compile it.
+
We assume that you are familiar with application development on the
Greenphone (or other Qtopia devices), so we won't go into detail here.
+++ /dev/null
-CMake supports and encourages out-of-source builds, which do not clutter the source directory.
-You can (and should) thus use an arbitrary directory for building.
-There is no "make distclean"; "make clean" should usually be enough since CMake actually
-cleans up properly (qmake often didn't). If you really want to get rid of all build files,
-just remove the build directory.
-
-Usually, you will build Quassel as follows:
-
-cd /path/to/build/dir
-cmake /path/to/quassel
-make
-
-Additionally, you may add some options to the cmake call, prefixed by -D. These need to follow
-the source directory PATH:
-
-cmake /path/to/quassel -D<option1> -D<option2>
-
-NOTE: In order to reconfigure, you need to remove CMakeCache.txt (or empty
- the build directory), otherwise cmake will ignore modified -D options!
-
-Quassel recognizes the following options:
-
--DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF)
- Allow to choose which Quassel binaries to build.
-
--DQT=/path/to/qt
- Use a non-system Qt installation. This is for example useful if you have a static
- Qt installed in some local dir.
-
--DSTATIC=1
- Enable static building of Quassel. You should link the static versions of some libs
- (in particular libstdc++.a) into /path/to/build/dir/staticlibs in oder to create
- a portable binary!
-
--DSTATICWIN=1
- Enable static building for Windows platforms. This adds some libs that are not automatically
- included for some reason.
-
-BUILDING ON WINDOWS:
---------------------
-We have tested building on Windows with a statically built Qt (with its /bin directory in %PATH%)
-and MSVC 2005/2008. Make sure that you use a "shell" that has all needed env variables setup,
-such as the "Visual Studio Command Prompt". You will also need the /bin of the Microsoft SDK in
-your %PATH% at least for VS 2008, otherwise rc.exe is not found.
-Currently, only building in the shell using nmake seems to work; CMake can also create MSVC project
-files, but they seem to be problematic. However, YMMV.
-
-After you have everything setup:
-
-cd C:\path\to\quassel-build
-cmake -G"NMake Makefiles" C:\path\to\quassel\source -DSTATICWIN=1
-nmake
+++ /dev/null
-# This file contains global build settings. Note that you can add stuff to CONFIG
-# by using qmake -config stuff
-# Notable examples:
-#
-# -config debug (or release or debug_and_release)
-# -config verbose (to enable verbose compiling)
-
-CONFIG += warn_on uic resources qt silent
-
-verbose {
- CONFIG -= silent
-}
-
-win32 {
- static {
- CONFIG = release warn_on uic resources qt windows static
- } else {
- CONFIG = warn_on uic resources qt silent windows
- }
-}
-
-mac:Tiger {
- QMAKE_MAC_SDK=/Developer/SDKs/MacOSX10.4u.sdk
- CONFIG += x86 ppc
-}
-
-sputdev {
- DEFINES *= SPUTDEV
-}
-
-profile {
- CONFIG += debug
- QMAKE_CXXFLAGS_DEBUG += -pg
- QMAKE_LFLAGS_DEBUG += -pg
-}
+++ /dev/null
-contains(CONTRIB, libqxt) {
- include(../contrib/libqxt-version.pri)
- QXTLIB = ../contrib
- QXTINC = ../../src/contrib/libqxt-$$QXTVER/deploy/include
- QXTREALINC = ../../src/contrib/libqxt-$$QXTVER/src
- INCLUDEPATH += $$QXTINC/QxtCore $$QXTINC/QxtNetwork $$QXTREALINC/network $$QXTREALINC/core
- LIBS += -L$$QXTLIB -lQxtNetwork -lQxtCore
-}
+++ /dev/null
-# This file needs to be copied into src/contrib/libqxt-$$QXTVER/config.pri if you
-# update the snapshot!
-
-# Stuff that is used by the libqxt project files
-CONFIG += static staticlibs
-CONFIG += release
-DEFINES *= HAVE_QT
-QXTBUILDDIR = ../../../../../build/contrib
-DESTDIR = $$QXTBUILDDIR
-MOC_DIR = $$QXTBUILDDIR/.libqxt/moc
-OBJECTS_DIR = $$QXTBUILDDIR/.libqxt/obj
+++ /dev/null
-# Version of the Qxt library. We expect to find it at src/contrib/libqxt-$$QXTVER.
-
-QXTVER = 2007-10-24
+++ /dev/null
-TEMPLATE = subdirs
-
-include(libqxt-version.pri)
-QXTDIR = ../../src/contrib/libqxt-$$QXTVER/src
-
-SUBDIRS = $$QXTDIR/core $$QXTDIR/network
+++ /dev/null
-MODULE = client
-include(module.pri)
+++ /dev/null
-MODULE = common
-include(module.pri)
+++ /dev/null
-MODULE = core
-include(module.pri)
+++ /dev/null
-# module.pri
-# This file is included by module project files.
-
-include(../buildconf.pri)
-
-TEMPLATE = lib
-CONFIG += staticlib
-
-SRCPATH = ../../src # Path to sources relative to this file
-
-# Set paths according to MODULE
-# We need to handle MODULE definitions like contrib/foo
-
-MODNAME = $$basename(MODULE)
-MODPATH_PREFIX = $$dirname(MODULE)
-!isEmpty(MODPATH_PREFIX) {
- MODPATH_PREFIX ~= s,[^/]+,..
- SRCPATH = $$MODPATH_PREFIX/$$SRCPATH
-}
-
-MODPATH = $$SRCPATH/$$MODULE # Path to the module files
-
-# Define build directories
-
-OBJECTS_DIR = $$MODNAME
-MOC_DIR = $$MODNAME
-UI_DIR = $$MODNAME
-
-# Load module settings (files etc.)
-
-include($$MODPATH/$${MODNAME}.pri)
-
-# Define needed Qt modules
-
-QT -= gui
-for(qtmod, QT_MOD) {
- QT *= $$qtmod
-}
-
-# Include contrib stuff
-
-include(../contrib/contrib.pri)
-
-# Set includepath for needed Quassel modules
-
-for(dep, DEPMOD) {
- INCLUDEPATH *= $$SRCPATH/$$dep
-}
-INCLUDEPATH *= $$MODPATH ../../ # and don't forget our own dir
-
-# Now prefix all filenames with the correct dirname
-
-for(src, SRCS) {
- SOURCES *= $$MODPATH/$$src
-}
-
-for(hdr, HDRS) {
- HEADERS *= $$MODPATH/$$hdr
-}
-
-for(frm, FRMS) {
- FORMS *= $$MODPATH/$$frm
-}
+++ /dev/null
-MODULE = qtui
-include(module.pri)
+++ /dev/null
-MODULE = uisupport
-include(module.pri)
+++ /dev/null
-# This project file can be used to set up a build environment for quassel.
-# To build the default configuration (i.e. qtgui, core and monolithic client),
-# simply run
-#
-# > qmake && make
-#
-# in this directory. In order to select the binaries to build, you may set
-# the BUILD variable as follows:
-#
-# > qmake BUILD=<mode> && make
-#
-# where <mode> is a quoted string that may contain any of 'qtgui', 'core', 'mono' or 'all'.
-#
-# NOTE: To change the build configuration, you have to run 'make distclean' first!
-
-TEMPLATE = subdirs
-
-TARGETS = qtclient core mono
-
-# Check build configuration
-isEmpty(BUILD): BUILD = all # build everything by default
-contains(BUILD, all): BUILD = $${TARGETS}
-
-# Find modules and targets to build
-for(target, TARGETS): contains(BUILD, $$target) {
- include(targets/$${target}.pri)
- BUILD_MODS *= $${MODULES}
- BUILD_TARGETS *= $$target
-}
-
-# Now add modules and their deps
-for(mod, BUILD_MODS) {
- include(../src/$${mod}/$${mod}.pri)
- SUBDIRS += mod_$${mod}
- eval(mod_$${mod}.file = modules/$${mod}.pro)
- eval(mod_$${mod}.makefile = Makefile.mod_$${mod}) # This prevents distclean from removing our Makefile -_-
- for(dep, DEPMOD): eval(mod_$${mod}.depends += mod_$${dep})
- export(mod_$${mod}.file)
- export(mod_$${mod}.makefile)
- export(mod_$${mod}.depends)
-}
-
-# Same with targets
-for(target, BUILD_TARGETS) {
- include(targets/$${target}.pri)
- SUBDIRS += $${target}
- eval($${target}.file = targets/$${target}.pro)
- eval($${target}.makefile = Makefile.target_$${target})
- for(mod, MODULES): eval($${target}.depends += mod_$${mod})
- export($${target}.file)
- export($${target}.makefile)
- export($${target}.depends)
-}
-
+++ /dev/null
-# Modules for quasselcore
-
-TARGET = quasselcore
-MODULES = core common
-DEFINES = BUILD_CORE
-
-QT -= gui
-QT += network sql script
-
+++ /dev/null
-include(core.pri)
-include(target.pri)
-
-RESOURCES *= ../../src/core/sql.qrc
+++ /dev/null
-# Modules for monolithic client
-
-TARGET = quassel
-MODULES = core qtui uisupport client common
-DEFINES = BUILD_MONO
-
-QT += network sql script
+++ /dev/null
-include(mono.pri)
-include(target.pri)
-
-RESOURCES *= ../../src/icons/icons.qrc \
- ../../src/icons/quassel-icons.qrc \
- ../../src/core/sql.qrc \
+++ /dev/null
-# Modules for quasselclient
-
-TARGET = quasselclient
-MODULES = qtui uisupport client common
-DEFINES = BUILD_QTUI
-
-QT += network script
-
-#RESOURCES *= ../../src/icons/icons.qrc ../../src/icons/quassel-icons.qrc
+++ /dev/null
-include(qtclient.pri)
-include(target.pri)
-
-RESOURCES *= ../../src/icons/icons.qrc ../../src/icons/quassel-icons.qrc
+++ /dev/null
-TEMPLATE = app
-
-include(../buildconf.pri)
-
-RESOURCES *= ../../i18n/i18n.qrc
-TRANSLATIONS = quassel_da.ts \
- quassel_de.ts
-
-SRCPATH = ../../src
-OBJECTS_DIR = .$$TARGET
-RCC_DIR = .$$TARGET
-
-linux-g++*:static {
- # We put libs in contrib/libs that should be linked statically, especially libstdc++.a
- LIBS *= -L../contrib/libs
- QMAKE_LFLAGS *= -static-libgcc
-}
-
-for(mod, MODULES) {
- INCLUDEPATH *= $$SRCPATH/$$mod
- LIBS *= -L../modules/$$dirname(mod) -l$$basename(mod)
- PRE_TARGETDEPS *= ../modules/$$mod
-}
-PRE_TARGETDEPS *= ../../version.inc
-
-#CONTRIB += libqxt # not needed
-#include(../contrib/contrib.pri)
-
-SOURCES = $$SRCPATH/common/main.cpp
-
-# This is really annoying, but for some reason win32 libs are not included by default.
-# Ugly workaround following...
-
-win32:static {
- RC_FILE = win32.rc
- CONFIG += embed_manifest_exe
- LIBS *= -luser32 -lgdi32 -lkernel32 -lshell32 -lwsock32 -lwinspool -lcomdlg32 -lole32
- LIBS *= -ladvapi32 -limm32 -luuid -lwinmm -ldelayimp -lopengl32 -lglu32 -loleaut32 -lws2_32
- LIBS *= -llibeay32MD -lssleay32MD
- QMAKE_LFLAGS_WINDOWS += /nodefaultlib:"libcmt.lib"
-
-}
-
-macx {
- ICON = ../../src/icons/quassel/quassel.icns
-}
+++ /dev/null
-IDI_ICON1 ICON DISCARDABLE "../../src/icons/quassel/quassel.ico"
\ No newline at end of file
+++ /dev/null
-qtopia_project(qtopia app)
-
-# error(QuasselTopia cannot be build at the moment. Its codebase is out of sync with the rest of Quassel. Please bear with us until we have fixed that!)
-
-TARGET = quasseltopia
-CONFIG += release qtopia_main no_quicklaunch no_singleexec
-QT += core gui network
-
-# Find files
-INCLUDEPATH += ../src/qtopia ../src/uisupport ../src/client ../src/common
-
-#DESTDIR = .
-#OBJECTS_DIR = .obj
-#MOC_DIR = .moc
-#UIC_DIR = .ui
-
-# Include .pri from src dirs
-include(../src/common/common.pri)
-include(../src/qtopia/qtopia.pri)
-include(../src/client/client.pri)
-include(../src/uisupport/uisupport.pri)
-
-# Fix variable names
-SOURCES = $$SRCS
-HEADERS = $$HDRS
-FORMS = $$FRMS
-
-# SXE permissions required
-#pkg.domain=
-#pkg.name=Quassel IRC
-
-desktop.files=../src/qtopia/quasseltopia.desktop
-desktop.path=/apps/Applications
-#desktop.trtarget=example-nct
-desktop.hint=desktop
-
-pics.files=../src/images/qirc-icon.png
-pics.path=/pics/quasselirc
-pics.hint=pics
-
-#help.source=help
-#help.files=example.html
-#help.hint=help
-
-INSTALLS+=desktop pics
-
-pkg.name=QuasselTopia
-pkg.desc=Quassel IRC, a modern, distributed IRC client
-pkg.version=0.1.0-pre
-pkg.maintainer=www.quassel-irc.org
-pkg.license=GPL
-pkg.domain=window,net
-
+++ /dev/null
-# This project file can be used to set up a build environment for quassel.
-# To build the default configuration (i.e. qtgui, core and monolithic client),
-# simply run
-#
-# > qmake && make
-#
-# in this directory. In order to select the binaries to build, you may set
-# the BUILD variable as follows:
-#
-# > qmake BUILD=<mode> && make
-#
-# where <mode> is a quoted string that may contain any of 'qtgui', 'core', 'mono' or 'all'.
-#
-# NOTE: To change the build configuration, you have to run 'make distclean' first!
-
-TEMPLATE = subdirs
-SUBDIRS += build/quassel.pro
+++ /dev/null
-DEPMOD = common
-QT_MOD = core network gui
-
-SRCS += buffer.cpp buffersettings.cpp clientbacklogmanager.cpp clientirclisthelper.cpp treemodel.cpp networkmodel.cpp buffermodel.cpp client.cpp clientsettings.cpp clientsyncer.cpp \
- irclistmodel.cpp mappedselectionmodel.cpp selectionmodelsynchronizer.cpp
-HDRS += buffer.h buffersettings.h clientbacklogmanager.h clientirclisthelper.h treemodel.h networkmodel.h buffermodel.h client.h clientsettings.h clientsyncer.h quasselui.h \
- irclistmodel.h mappedselectionmodel.h selectionmodelsynchronizer.h
+++ /dev/null
-DEPMOD =
-QT_MOD = network
-
-SRCS += backlogmanager.cpp bufferinfo.cpp buffersyncer.cpp bufferviewconfig.cpp bufferviewmanager.cpp global.cpp identity.cpp \
- logger.cpp message.cpp settings.cpp signalproxy.cpp syncableobject.cpp \
- util.cpp network.cpp ircuser.cpp ircchannel.cpp
-HDRS += backlogmanager.h bufferinfo.h buffersyncer.h bufferviewconfig.h bufferviewmanager.h global.h identity.h \
- irclisthelper.h logger.h message.h settings.h signalproxy.h syncableobject.h \
- util.h network.h ircuser.h ircchannel.h types.h
+++ /dev/null
-DEPMOD = common
-QT_MOD = core network sql script
-
-SRCS = core.cpp corebacklogmanager.cpp corebufferviewconfig.cpp corebufferviewmanager.cpp coreirclisthelper.cpp corenetwork.cpp coresession.cpp coresettings.cpp networkconnection.cpp sqlitestorage.cpp abstractsqlstorage.cpp storage.cpp basichandler.cpp \
- ircserverhandler.cpp userinputhandler.cpp ctcphandler.cpp coreusersettings.cpp sessionthread.cpp
-HDRS = core.h corebacklogmanager.h corebufferviewconfig.h corebufferviewmanager.h coreirclisthelper.h corenetwork.h coresession.h coresettings.h networkconnection.h sqlitestorage.h abstractsqlstorage.h storage.h basichandler.h \
- ircserverhandler.h userinputhandler.h ctcphandler.h coreusersettings.h sessionthread.h
-
-contains(QT_CONFIG, openssl) | contains(QT_CONFIG, openssl-linked) {
- SRCS += sslserver.cpp
- HDRS += sslserver.h
-}
+++ /dev/null
-DEPMOD = uisupport common client
-QT_MOD = core gui network
-
-HDRS += bufferviewwidget.h chatline.h chatwidget.h coreconnectdlg.h mainwidget.h nicklistwidget.h \
- qtopiaui.h qtopiamainwin.h qtopiauistyle.h topicbar.h
-SRCS += bufferviewwidget.cpp chatline.cpp chatwidget.cpp coreconnectdlg.cpp main.cpp mainwidget.cpp nicklistwidget.cpp \
- qtopiaui.cpp qtopiamainwin.cpp qtopiauistyle.cpp topicbar.cpp
-FORMNAMES += aboutdlg.ui bufferviewwidget.ui coreconnectdlg.ui coreconnectprogressdlg.ui coreaccounteditdlg.ui mainwidget.ui nicklistwidget.ui
-
-for(ui, FORMNAMES) {
- FRMS += ui/$${ui}
-}
+++ /dev/null
-DEPMOD = client common uisupport
-QT_MOD = core gui network
-
-SRCS += aboutdlg.cpp bufferwidget.cpp channellistdlg.cpp chatline-old.cpp chatwidget.cpp \
- coreconfigwizard.cpp coreconnectdlg.cpp debugconsole.cpp inputwidget.cpp \
- mainwin.cpp nicklistwidget.cpp qtui.cpp qtuisettings.cpp qtuistyle.cpp settingsdlg.cpp settingspagedlg.cpp \
- titlesetter.cpp topicbutton.cpp topicwidget.cpp verticaldock.cpp jumpkeyhandler.cpp
-
-HDRS += aboutdlg.h bufferwidget.h channellistdlg.h chatline-old.h chatwidget.h \
- coreconfigwizard.h debugconsole.h inputwidget.h \
- coreconnectdlg.h mainwin.h nicklistwidget.h qtui.h qtuisettings.h qtuistyle.h settingsdlg.h settingspagedlg.h \
- titlesetter.h topicbutton.h topicwidget.h verticaldock.h jumpkeyhandler.h
-
-FORMNAMES = aboutdlg.ui mainwin.ui channellistdlg.ui coreaccounteditdlg.ui coreconnectdlg.ui bufferviewwidget.ui bufferwidget.ui nicklistwidget.ui settingsdlg.ui \
- settingspagedlg.ui topicwidget.ui debugconsole.ui inputwidget.ui \
- coreconfigwizardintropage.ui coreconfigwizardadminuserpage.ui coreconfigwizardstorageselectionpage.ui coreconfigwizardsyncpage.ui
-
-for(ui, FORMNAMES) {
- FRMS += ui/$${ui}
-}
-
-# Include settingspages
-include(settingspages/settingspages.pri)
-for(page, SETTINGSPAGES) {
- SRCS += settingspages/$${page}settingspage.cpp
- HDRS += settingspages/$${page}settingspage.h
- FRMS += settingspages/$${page}settingspage.ui
-}
-
-# Include additional files
-for(src, SP_SRCS) {
- SRCS += settingspages/$${src}
-}
-for(hdr, SP_HDRS) {
- HDRS += settingspages/$${hdr}
-}
-for(frm, SP_FRMS) {
- FRMS += settingspages/$${frm}
-}
+++ /dev/null
-# Putting $FOO in SETTINGSPAGES automatically includes
-# $FOOsettingspage.cpp, $FOOsettingspage.h and $FOOsettingspage.ui
-SETTINGSPAGES = appearance bufferview color fonts general highlight identities networks
-
-# Specify additional files (e.g. for subdialogs) here!
-SP_SRCS =
-SP_HDRS =
-SP_FRMS = buffervieweditdlg.ui createidentitydlg.ui saveidentitiesdlg.ui networkeditdlg.ui nickeditdlg.ui servereditdlg.ui
+++ /dev/null
-DEPMOD = common client
-QT_MOD = core gui network
-
-SRCS += abstractbuffercontainer.cpp abstractitemview.cpp bufferview.cpp bufferviewfilter.cpp clearablelineedit.cpp colorbutton.cpp \
- nickviewfilter.cpp inputline.cpp nickview.cpp settingspage.cpp tabcompleter.cpp uisettings.cpp uistyle.cpp uistylesettings.cpp
-HDRS += abstractbuffercontainer.h abstractitemview.h bufferview.h bufferviewfilter.h clearablelineedit.h colorbutton.h \
- nickviewfilter.h inputline.h nickview.h settingspage.h tabcompleter.h uisettings.h uistyle.h uistylesettings.h
-
-FORMNAMES =
-
-for(ui, FORMNAMES) {
- FRMS += ui/$${ui}
-}
projects / quassel.git / commitdiff