From owner-freebsd-doc@FreeBSD.ORG Mon May 14 08:40:02 2012 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 61DC71065672 for ; Mon, 14 May 2012 08:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 334CC8FC15 for ; Mon, 14 May 2012 08:40:02 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.5/8.14.5) with ESMTP id q4E8e2Bm012773 for ; Mon, 14 May 2012 08:40:02 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.5/8.14.5/Submit) id q4E8e2CJ012772; Mon, 14 May 2012 08:40:02 GMT (envelope-from gnats) Resent-Date: Mon, 14 May 2012 08:40:02 GMT Resent-Message-Id: <201205140840.q4E8e2CJ012772@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Alberto Villa Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 9CE68106566B for ; Mon, 14 May 2012 08:33:53 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22]) by mx1.freebsd.org (Postfix) with ESMTP id 8640D8FC08 for ; Mon, 14 May 2012 08:33:53 +0000 (UTC) Received: from red.freebsd.org (localhost [127.0.0.1]) by red.freebsd.org (8.14.4/8.14.4) with ESMTP id q4E8Xrs6099815 for ; Mon, 14 May 2012 08:33:53 GMT (envelope-from nobody@red.freebsd.org) Received: (from nobody@localhost) by red.freebsd.org (8.14.4/8.14.4/Submit) id q4E8XrGQ099781; Mon, 14 May 2012 08:33:53 GMT (envelope-from nobody) Message-Id: <201205140833.q4E8XrGQ099781@red.freebsd.org> Date: Mon, 14 May 2012 08:33:53 GMT From: Alberto Villa To: freebsd-gnats-submit@FreeBSD.org X-Send-Pr-Version: www-3.1 Cc: Subject: docs/167864: [patch] Update KDE documentation in Handbook and Porter's Handbook X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 14 May 2012 08:40:02 -0000 >Number: 167864 >Category: docs >Synopsis: [patch] Update KDE documentation in Handbook and Porter's Handbook >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon May 14 08:40:01 UTC 2012 >Closed-Date: >Last-Modified: >Originator: Alberto Villa >Release: >Organization: >Environment: >Description: KDE documentation is quite outdated both in the Handbook and in the Porter's Handbook. The attached patch updates it and cleans it up, and fixes a serious documentation bug within the KDM section. >How-To-Repeat: >Fix: Patch attached with submission follows: Index: handbook/x11/chapter.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/handbook/x11/chapter.sgml,v retrieving revision 1.212 diff -u -r1.212 chapter.sgml --- handbook/x11/chapter.sgml 16 Feb 2012 05:06:57 -0000 1.212 +++ handbook/x11/chapter.sgml 14 May 2012 08:30:41 -0000 @@ -1323,9 +1323,9 @@ Several replacements for the default XDM program exist. One of them, - kdm (bundled with + KDM (bundled with KDE) is described later in this - chapter. The kdm display manager offers many visual + chapter. The KDM display manager offers many visual improvements and cosmetic frills, as well as the functionality to allow users to choose their window manager of choice at login time. @@ -1460,7 +1460,7 @@ Yet another option is to configure the display manager to allow choosing the window manager at login time; the section on KDE details - explains how to do this for kdm, the + explains how to do this for KDM, the display manager of KDE. @@ -1504,7 +1504,7 @@ Internationalization: KDE - is available in more than 40 languages + is available in more than 55 languages @@ -1525,13 +1525,15 @@ can be found on the KDE website. For FreeBSD specific information and resources on KDE, consult - the KDE on FreeBSD - team's website. + the KDE/FreeBSD + initiative's website. - There are two versions of KDE available on FreeBSD. Version 3 - has been around for a long time, and is very mature. Version 4, - the next generation, is also available in the Ports Collection. - They can even be installed side by side. + There are two versions of KDE available + on FreeBSD. Version 3 has been around for a long time, and is still + available in the Ports Collection though it's now unmaintained and + partially broken. Version 4 is punctually updated and is the default + choice for KDE users. They can even be + installed side by side. @@ -1541,12 +1543,12 @@ other desktop environment, the software can be easily installed from a package or the Ports Collection: - To install the KDE3 package + To install the KDE 3 package from the network, simply type: &prompt.root; pkg_add -r kde - To install the KDE4 package + To install the KDE 4 package from the network, simply type: &prompt.root; pkg_add -r kde4 @@ -1554,13 +1556,13 @@ &man.pkg.add.1; will automatically fetch the latest version of the application. - To build KDE3 from source, + To build KDE 3 from source, use the ports tree: &prompt.root; cd /usr/ports/x11/kde3 &prompt.root; make install clean - To build KDE4 from source, + To build KDE 4 from source, use the ports tree: &prompt.root; cd /usr/ports/x11/kde4 @@ -1571,12 +1573,12 @@ instead of the default window manager. This is accomplished by editing the .xinitrc file: - For KDE3: - + For KDE 3: + &prompt.user; echo "exec startkde" > ~/.xinitrc - For KDE4: - + For KDE 4: + &prompt.user; echo "exec /usr/local/kde4/bin/startkde" > ~/.xinitrc Now, whenever the X Window System is invoked with @@ -1587,7 +1589,7 @@ XDM is being used, the configuration is slightly different. Edit the .xsession file instead. Instructions - for kdm are described later in + for KDM are described later in this chapter. @@ -1618,28 +1620,28 @@ XDM can be used, as described earlier. However, KDE includes an - alternative, kdm, which is designed + alternative, KDM, which is designed to look more attractive and include more login-time options. In particular, users can easily choose (via a menu) which desktop environment (KDE, GNOME, or something else) to run after logging on. - To enable kdm, different files + To enable KDM, different files need to be edited depending on the version of KDE. - For KDE3, the ttyv8 + For KDE 3, the ttyv8 entry in /etc/ttys has to be adapted as follows: ttyv8 "/usr/local/bin/kdm -nodaemon" xterm on secure - For KDE4, you have to add the - following lines to /etc/rc.conf: + For KDE 4, you have to mount + &man.procfs.5; and add the following line to + /etc/rc.conf: - local_startup="${local_startup} /usr/local/kde4/etc/rc.d" -kdm4_enable="YES" + kdm4_enable="YES" Index: porters-handbook/book.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.1186 diff -u -r1.1186 book.sgml --- porters-handbook/book.sgml 2 May 2012 10:21:37 -0000 1.1186 +++ porters-handbook/book.sgml 14 May 2012 08:30:44 -0000 @@ -1742,8 +1742,7 @@ kde* Ports from the K Desktop Environment - (KDE) Project. + url="http://www.kde.org">KDE Project. @@ -6004,7 +6003,8 @@ QTNONSTANDARD Suppress modification of CONFIGURE_ENV, - CONFIGURE_ARGS, and + CONFIGURE_ARGS, + CPPFLAGS and MAKE_ENV. @@ -6019,30 +6019,26 @@ QT_COMPONENTS - Specify tool and library dependencies for Qt4. + Specify tool and library dependencies for Qt 4. See below for details. UIC Set to the path of uic - (read-only variable). Default set according to - USE_QT_VER value. + (read-only variable). QMAKE Set to the path of qmake - (read-only variable). Default set according to - USE_QT_VER value. + (read-only variable). QMAKESPEC Set to the path of configuration file for - qmake (read-only variable). - Default set according to - USE_QT_VER value. + qmake (read-only variable). @@ -6056,8 +6052,9 @@ --with-qt-libraries=${QT_PREFIX}/lib \ --with-extra-libs=${LOCALBASE}/lib \ --with-extra-includes=${LOCALBASE}/include -CONFIGURE_ENV+= MOC="${MOC}" CPPFLAGS="${CPPFLAGS} ${QTCPPFLAGS}" LIBS="${QTCFGLIBS}" \ - QTDIR="${QT_PREFIX}" KDEDIR="${KDE_PREFIX}" +CONFIGURE_ENV+= MOC="${MOC}" LIBS="${QTCFGLIBS}" \ + QTDIR="${QT_PREFIX}" KDEDIR="${KDE_PREFIX}" +CPPFLAGS+= ${QTCPPFLAGS} If USE_QT_VER is set to 4, the following settings are also @@ -6070,8 +6067,8 @@ Component Selection (Qt 4.x Only) - When USE_QT_VER is set to 4, - individual Qt4 tool and library dependencies can be + When USE_QT_VER is set to 4, + individual Qt 4 tool and library dependencies can be specified in the QT_COMPONENTS variable. Every component can be suffixed by either _build or _run, the @@ -6088,7 +6085,7 @@ /usr/ports/Mk/bsd.qt.mk): - Available Qt4 Library Components + Available Qt 4 Library Components @@ -6122,7 +6119,7 @@ qt3support - Qt3 compatibility library + Qt 3 compatibility library @@ -6154,7 +6151,7 @@ executable after a successful compilation.
- Available Qt4 Tool Components + Available Qt 4 Tool Components @@ -6178,7 +6175,7 @@ rcc - resource compiler (need if the application + resource compiler (needed if the application comes with *.rc or *.qrc files) @@ -6195,7 +6192,7 @@
- Available Qt4 Plugin Components + Available Qt 4 Plugin Components @@ -6223,17 +6220,18 @@
- Selecting Qt4 Components + Selecting Qt 4 Components - In this example, the ported application uses the Qt4 - graphical user interface library, the Qt4 core library, - all of the Qt4 code generation tools and Qt4's Makefile - generator. Since the gui library implies a dependency on - the core library, corelib does not need to be specified. - The Qt4 code generation tools moc, uic and rcc, as well as - the Makefile generator qmake are only needed at buildtime, - thus they are specified with the _build - suffix: + In this example, the ported application uses the Qt 4 + graphical user interface library, the Qt 4 core library, + all of the Qt 4 code generation tools and Qt 4's Makefile + generator. Since the gui library implies + a dependency on the core library, corelib + does not need to be specified. The Qt 4 code generation tools + moc, uic and + rcc, as well as the Makefile generator + qmake are only needed at buildtime, thus they + are specified with the _build suffix: USE_QT_VER= 4 QT_COMPONENTS= gui moc_build qmake_build rcc_build uic_build @@ -6252,7 +6250,7 @@ do-configure: @cd ${WRKSRC} && ${SETENV} ${CONFIGURE_ENV} \ - ${QMAKE} -unix PREFIX=${PREFIX} texmaker.pro + ${QMAKE} PREFIX=${PREFIX} texmaker.pro Note the similarity to the qmake line from the provided BUILD.sh script. @@ -6271,14 +6269,14 @@ Missing additional - includepaths. Many applications come with + include paths. Many applications come with system tray icon support, but neglect to look for includes and/or libraries in the X11 directories. You can tell qmake to add directories to - the include and library searchpaths via the command + the include and library search paths via the command line, for example: - ${QMAKE} -unix PREFIX=${PREFIX} INCLUDEPATH+=${LOCALBASE}/include \ + ${QMAKE} PREFIX=${PREFIX} INCLUDEPATH+=${LOCALBASE}/include \ LIBS+=-L${LOCALBASE}/lib sillyapp.pro @@ -6287,12 +6285,12 @@ Sometimes data such as icons or .desktop files are by default installed into directories which aren't scanned by XDG-compatible applications. editors/texmaker is an + role="package">editors/texmaker is an example for this - look at patch-texmaker.pro in the files directory of that port for a - template on how to remedy this directly in the Qmake - project file. + template on how to remedy this directly in the + qmake project file. @@ -6336,13 +6334,18 @@ If your application depends on KDE 4.x, set USE_KDE4 to the list of required - components. The most commonly used components are listed - below (up-to-date components are listed in - _USE_KDE4_ALL in + components. _build and _run + suffixes can be used to force components dependency type + (e.g., baseapps_run). If no suffix is set, + a default dependency type will be used. If you want to force + both types, add the component twice with both suffixes + (e.g., automoc4_build automoc4_run). + The most commonly used components are listed below (up-to-date + components are documented at the top of /usr/ports/Mk/bsd.kde4.mk): - Available KDE4 Components + Available KDE 4 Components @@ -6354,36 +6357,18 @@ - akonadi - Personal information management (PIM) storage - service - - - - automoc4 - Makes port use automoc4 build tool - - - - kdebase - Basic KDE applications (Konqueror, Dolphin, - Konsole) - - - - kdeexp - Experimental KDE libraries (with non-stable - API) + baseapps + Basic applications for KDE Desktop kdehier - Provides common KDE directories + Hierarchy of common KDE directories kdelibs - The base set of KDE libraries + KDE Developer Platform @@ -6395,60 +6380,58 @@ pimlibs - PIM libraries + KDE-Pim libraries workspace - Applications and libraries which form desktop - (Plasma, KWin) + KDE user environments + + + + akonadi + Storage server for KDE-Pim + + + + automoc4 + Automatic moc for Qt 4 packages
KDE 4.x ports are installed into - ${KDE4_PREFIX}, which is + KDE4_PREFIX, which is /usr/local/kde4 currently, to avoid conflicts with KDE 3.x ports. This is achieved by specifying the kdeprefix component, which overrides the default PREFIX. The ports however respect any PREFIX set via MAKEFLAGS environment variable and/or - make arguments. - - KDE 4.x ports may conflict with KDE 3.x ports, so when - the kdeprefix component is enabled, they - are installed in ${KDE4_PREFIX}. - The default value of KDE4_PREFIX is - currently /usr/local/kde4. Installing - the KDE 4.x ports into a custom PREFIX is - also possible. When PREFIX is set via - the MAKEFLAGS environment variable or via - make options it overrides the - value configured by kdeprefix. + make arguments. <makevar>USE_KDE4</makevar> Example - This is a simple example for KDE 4 port. - USE_CMAKE instructs port to utilize + This is a simple example for a KDE 4 port. + USE_CMAKE instructs the port to utilize CMake — configuration tool widely spread among KDE 4 projects. USE_KDE4 brings dependency on KDE libraries and makes port using - automoc4 at build stage. + automoc4 at build stage. Required KDE components and other dependencies can be determined through configure log. USE_KDE4 does not imply USE_QT_VER. If a port requires some - Qt4 components, USE_QT_VER should be + Qt 4 components, USE_QT_VER should be set and then needed components can be specified. USE_CMAKE= yes -USE_KDE4= automoc4 kdelibs kdeprefix +USE_KDE4= kdelibs kdeprefix automoc4 USE_QT_VER= 4 -QT_COMPONENTS= qmake_build moc_build rcc_build uic_build +QT_COMPONENTS= moc_build qmake_build rcc_build uic_build >Release-Note: >Audit-Trail: >Unformatted: