summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRalf Habacker <ralf.habacker@freenet.de>2011-07-02 19:02:46 (GMT)
committerRalf Habacker <ralf.habacker@freenet.de>2011-07-02 19:02:46 (GMT)
commit6321a9849258a879c8779d80e544093d65fa9c81 (patch)
treef37f1c0e6fe97977fb3e1c241576376600ad4ed5
parenta7f98d881903beb70b40550c34324210038dabc7 (diff)
downloaddbus-6321a9849258a879c8779d80e544093d65fa9c81.tar.gz
dbus-6321a9849258a879c8779d80e544093d65fa9c81.tar.xz
Collected cmake doc into README.cmake.
-rw-r--r--README24
-rw-r--r--README.cmake150
-rw-r--r--cmake/readme-cmake.txt39
3 files changed, 152 insertions, 61 deletions
diff --git a/README b/README
index 3ab6f2e..3e2ae2d 100644
--- a/README
+++ b/README
@@ -77,28 +77,8 @@ Configuration flags
When using autotools, run "./configure --help" to see the possible
configuration options and environment variables.
-When using the cmake build system the dbus-specific configuration flags that can be given
-to the cmake program are these (use -D<key>=<value> on command line)
-
- CMAKE_BUILD_TYPE set dbus build mode - one of Debug|Release|RelWithDebInfo|MinSizeRel
- DBUS_BUILD_TESTS enable unit test code default=ON
- DBUS_BUILD_X11 Build with X11 autolaunch support default=ON
- HAVE_CONSOLE_OWNER_FILE enable console owner file (solaris only) ) default=ON
- DBUS_DISABLE_ASSERTS Disable assertion checking default=OFF
- DBUS_DISABLE_CHECKS Disable public API sanity checking default=OFF
- DBUS_ENABLE_ABSTRACT_SOCKETS enable support for abstract sockets (linux only) default=ON
- DBUS_ENABLE_ANSI enable -ansi -pedantic gcc flags default=OFF
- DBUS_ENABLE_DNOTIFY build with dnotify support (linux only) default=ON
- DBUS_ENABLE_VERBOSE_MODE support verbose debug mode default=ON
- DBUS_ENABLE_DOXYGEN_DOCS build DOXYGEN documentation (requires Doxygen) default=ON
- DBUS_GCOV_ENABLED compile with coverage profiling instrumentation (gcc only) default=OFF
- DBUS_INSTALL_SYSTEM_LIBS install required system libraries default (windows only) =OFF
- DBUS_USE_EXPAT Use expat (== ON) or libxml2 (==OFF) default=ON [1]
- DBUS_USE_NONCE_TCP_DEFAULT_ADDRESS Use nonce tcp default address default=OFF
- DBUS_USE_OUTPUT_DEBUG_STRING enable win32 debug port for message output default=OFF
-
- [1] requires installed development package of the related dependency
-
+When using cmake, inspect README.cmake to see the possible
+configuration options and environment variables.
API/ABI Policy
===
diff --git a/README.cmake b/README.cmake
new file mode 100644
index 0000000..ea3b107
--- /dev/null
+++ b/README.cmake
@@ -0,0 +1,150 @@
+This file describes how to compile dbus using the cmake build system
+
+Requirements
+------------
+- cmake version >= 2.4.4 see http://www.cmake.org
+- installed libexpat
+
+Building
+--------
+
+Win32 MinGW
+1. install cmake and libexpat
+2. get dbus sources
+3. unpack dbus sources into a sub directory (referred as <dbus-src-root> later)
+4. mkdir dbus-build
+5. cd dbus-build
+6. run
+ cmake -G "MinGW Makefiles" [<options, see below>] <dbus-src-root>/cmake
+ mingw32-make
+ mingw32-make install
+
+Win32 Microsoft nmake
+1. install cmake and libexpat
+2. get dbus sources
+3. unpack dbus sources into a sub directory (referred as <dbus-src-root> later)
+4. mkdir dbus-build
+5. cd dbus-build
+6. run
+ cmake -G "NMake Makefiles" [<options, see below>] <dbus-src-root>/cmake
+ nmake
+ nmake install
+
+Win32 Visual Studio IDE
+1. install cmake and libexpat
+2. get dbus sources
+3. unpack dbus sources into a sub directory (referred as <dbus-src-root> later)
+4. mkdir dbus-build
+5. cd dbus-build
+6. run
+ cmake -G "Visual Studio 10" [<options, see below>] <dbus-src-root>/cmake
+ start
+ nmake install
+
+Linux
+1. install cmake and libexpat
+2. get dbus sources
+3. unpack dbus sources into a sub directory (referred as <dbus-src-root> later)
+4. mkdir dbus-build
+5. cd dbus-build
+6. run
+ cmake -G "<for available targets, see cmake --help for a list>" [<options, see below>] <dbus-src-root>/cmake
+ make
+ make install
+
+For other compilers see cmake --help in the Generators section
+
+Configuration flags
+-------------------
+
+When using the cmake build system the dbus-specific configuration flags that can be given
+to the cmake program are these (use -D<key>=<value> on command line). The listed values
+are the defaults.
+
+// Choose the type of build, options are: None(CMAKE_CXX_FLAGS or
+// CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel.
+CMAKE_BUILD_TYPE:STRING=Debug
+
+// Include path for 3rdparty packages
+CMAKE_INCLUDE_PATH:PATH=
+
+// Library path for 3rdparty packages
+CMAKE_LIBRARY_PATH:PATH=
+
+// Install path prefix, prepended onto install directories.
+CMAKE_INSTALL_PREFIX:PATH=C:/Program Files/dbus
+
+
+// enable unit test code
+DBUS_BUILD_TESTS:BOOL=ON
+
+// The name of the dbus daemon executable
+DBUS_DAEMON_NAME:STRING=dbus-daemon
+
+// Disable assertion checking
+DBUS_DISABLE_ASSERTS:BOOL=OFF
+
+// Disable public API sanity checking
+DBUS_DISABLE_CHECKS:BOOL=OFF
+
+// enable -ansi -pedantic gcc flags
+DBUS_ENABLE_ANSI:BOOL=OFF
+
+// build DOXYGEN documentation (requires Doxygen)
+DBUS_ENABLE_DOXYGEN_DOCS:BOOL=OFF
+
+// enable bus daemon usage statistics
+DBUS_ENABLE_STATS:BOOL=OFF
+
+// support verbose debug mode
+DBUS_ENABLE_VERBOSE_MODE:BOOL=ON
+
+// build XML documentation (requires xmlto or meinproc4)
+DBUS_ENABLE_XML_DOCS:BOOL=ON
+
+// Some atomic integer implementation present
+DBUS_HAVE_ATOMIC_INT:BOOL=OFF
+
+// install required system libraries
+DBUS_INSTALL_SYSTEM_LIBS:BOOL=OFF
+
+// session bus default address
+DBUS_SESSION_BUS_DEFAULT_ADDRESS:STRING=nonce-tcp:
+
+// system bus default address
+DBUS_SYSTEM_BUS_DEFAULT_ADDRESS:STRING=nonce-tcp:
+
+// Use atomic integer implementation for 486
+DBUS_USE_ATOMIC_INT_486:BOOL=OFF
+
+// Use expat (== ON) or libxml2 (==OFF)
+DBUS_USE_EXPAT:BOOL=ON
+
+win32 only:
+// enable win32 debug port for message output
+DBUS_USE_OUTPUT_DEBUG_STRING:BOOL=OFF
+
+gcc only:
+// compile with coverage profiling instrumentation
+DBUS_GCOV_ENABLED:BOOL=OFF
+
+linux only:
+// build with dnotify support
+DBUS_BUS_ENABLE_DNOTIFY_ON_LINUX:BOOL=ON
+
+solaris only:
+// enable console owner file
+HAVE_CONSOLE_OWNER_FILE:BOOL=ON
+
+// Directory to check for console ownership
+DBUS_CONSOLE_OWNER_FILE:STRING=/dev/console
+
+x11 only:
+// Build with X11 auto launch support
+DBUS_BUILD_X11:BOOL=ON
+
+
+Note: The above mentioned options could be extracted after
+configuring from the output of running "<maketool> help-options"
+in the build directory. The related entries start with
+CMAKE_ or DBUS_.
diff --git a/cmake/readme-cmake.txt b/cmake/readme-cmake.txt
deleted file mode 100644
index 4056d3c..0000000
--- a/cmake/readme-cmake.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-This directory contains configuration files for the cmake build system
-
-Requirements
-------------
-- cmake version >= 2.4.4 see http://www.cmake.org
-- installed libxml2 or libexpat
-
-Building
---------
-
-unix
-1. install cmake and libxml or libexpat
-2. get dbus sources
-3. mkdir dbus-build
-4. cd dbus-build
-5. cmake <dbus-src-root>/cmake or cmake -DDBUS_USE_EXPAT=on <dbus-src-root>/cmake in case libexpat should de used
-5. make
-6. make install
-
-win32-mingw
-1. install cmake and libxml or libexpat in <ProgramDir>\gnuwin32
-2. get dbus sources
-3. mkdir dbus-build
-4. cd dbus-build
-5. cmake -G "MinGW Makefiles" <dbus-src-root>/cmake
-6. make
-7. make install
-
-win32-msvc
-1. install cmake and libxml or libexpat in <ProgramDir>\gnuwin32
-2. get dbus sources
-3. mkdir dbus-build
-4. cd dbus-build
-5. cmake -G <msvc available target, see cmake --help for a list> <dbus-src-root>/cmake
-6. make
-7. make install
-
-A list of all available build options could be find in the file ../README.
-