[smb4k] doc: Started to update handbook.
Alexander Reinholdt
alexander.reinholdt at kdemail.net
Fri Aug 19 14:07:10 UTC 2016
Git commit 55f9604040af7305ae2356a9aaee598aba45519e by Alexander Reinholdt.
Committed on 19/08/2016 at 14:02.
Pushed by areinholdt into branch 'master'.
Started to update handbook.
M +60 -41 doc/index.docbook
http://commits.kde.org/smb4k/55f9604040af7305ae2356a9aaee598aba45519e
diff --git a/doc/index.docbook b/doc/index.docbook
index 86a3676..027ae73 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -24,14 +24,14 @@
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
-<year>2005-2015</year>
+<year>2005-2016</year>
<holder>Alexander Reinholdt</holder>
</copyright>
<legalnotice>&underFDL;</legalnotice>
-<date>2015-02-15</date>
-<releaseinfo>5.1.0</releaseinfo>
+<date>2016-yy-xx</date>
+<releaseinfo>6.0.0</releaseinfo>
<abstract>
-<para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility for KDE.</para>
+<para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
@@ -45,7 +45,7 @@
<chapter id="introduction" >
<title>Introduction</title>
-<para>This handbook describes &smb4k; 1.2.x and to some extent earlier versions.</para>
+<para>This handbook describes &smb4k; 2.0.x and to some extent earlier versions.</para>
<para>&smb4k; is an advanced network neighborhood browser and <ulink url="http://www.samba.org">Samba</ulink> share mounting utility. It provides many handy features that ease your life in a mostly &Windows;-dominated network environment:</para>
@@ -4450,7 +4450,7 @@ of the &kde; Fundamentals.</para>
<listitem><para>Provide the version of &smb4k; and &kde;.</para></listitem>
<listitem><para>Mention your operating system (&Linux;, FreeBSD, &etc;) and the distribution that is running on your computer.</para></listitem>
<listitem><para>Include the full error message if an error dialog was displayed.</para></listitem>
-<listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> appendix.</para></listitem>
+<listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> chapter in the appendix.</para></listitem>
<listitem><para>Add additional data, ⪚ send a screen shot if you are reporting a &GUI; related problem.</para></listitem>
</itemizedlist>
<para>The recommended method to report a bug is to go to our <ulink url="https://sourceforge.net/p/smb4k/tickets/">bug tracking system</ulink> and fill out the form. But you can also use the dialog that opens when you click the <menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice> menu item.</para>
@@ -4462,27 +4462,27 @@ of the &kde; Fundamentals.</para>
<chapter id="credits" >
<title>Credits and License</title>
-<para>Copyright © 2003 - 2015, Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para>
+<para>Copyright © 2003 - 2016, Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
<simplesect>
-<title>Developers</title>
-<itemizedlist>
-<listitem><para>Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para></listitem>
-</itemizedlist>
+ <title>Developers</title>
+ <itemizedlist>
+ <listitem><para>Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para></listitem>
+ </itemizedlist>
</simplesect>
<simplesect>
-<title>Translations</title>
-<para>Translations were contributed by the &kde; translators.</para>
+ <title>Translations</title>
+ <para>Translations were contributed by the &kde; translators.</para>
</simplesect>
<simplesect>
-<title>Special Thanks</title>
-<para>The &smb4k; team would like to thank everyone who contributed by sending patches. Also, a big "Thank you!" goes to Rashid N. Achilov <email>shelton at sentry.granch.ru</email>, who convinced us to port &smb4k; to FreeBSD and helped us a great deal to achieve this goal.</para>
+ <title>Special Thanks</title>
+ <para>The &smb4k; team would like to thank everyone who contributed by sending patches. Also, a big "Thank you!" goes to Rashid N. Achilov <email>shelton at sentry.granch.ru</email>, who convinced us to port &smb4k; to FreeBSD and helped us a great deal to achieve this goal.</para>
</simplesect>
</chapter>
@@ -4503,45 +4503,61 @@ of the &kde; Fundamentals.</para>
<para>&smb4k; officially supports &Linux;, FreeBSD and NetBSD. Other operating systems might work as well, but haven't been tested.</para>
<para>To compile &smb4k;, you need:</para>
<itemizedlist>
- <listitem><para><ulink url="http://www.cmake.org">CMake</ulink> (>= 2.8)</para></listitem>
- <listitem><para><ulink url="http://gcc.gnu.org">GNU Compiler Collection</ulink> (g++ >= 4.0) or <ulink url="http://clang.llvm.org">clang/LLVM</ulink> (>= 3.0)</para></listitem>
+ <listitem><para><ulink url="http://www.cmake.org">CMake</ulink> (≥ 3.3)</para></listitem>
+ <listitem><para><ulink url="http://gcc.gnu.org">GNU Compiler Collection</ulink> (g++ ≥ 4.0) or <ulink url="http://clang.llvm.org">clang/LLVM</ulink> (≥ 3.0)</para></listitem>
</itemizedlist>
-<para>&smb4k; depends on the following libraries:</para>
+<para>&smb4k; depends on the following <ulink url="http://www.qt.io">&Qt;</ulink> (≥ 5.4.0) and <ulink url="http://www.kde.org">&kf5;</ulink> (≥ 5.9.0) modules:</para>
<itemizedlist>
- <listitem><para><ulink url="http://www.kde.org">kdelibs and kde-runtime</ulink> (>= 4.8.0 or >= 4.10.0 for the plasmoid)</para></listitem>
- <listitem><para><ulink url="http://www.qt.io">&Qt;</ulink> (>= 4.8.0, but < 5.x)</para></listitem>
- <listitem><para>an implementation of the C library</para></listitem>
+ <listitem><para>QtCore, QtGui, QtWidgets, QtTest, QtNetwork, QtPrintSupport, QtQml</para></listitem>
+ <listitem><para>KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, KJobWidgets, KWallet, KDBusAddons, KParts, KConfigWidgets, KNotifications, KWindowSystem</para></listitem>
</itemizedlist>
<para>For a proper operation, you also need:</para>
<itemizedlist>
- <listitem><para><ulink url="http://www.samba.org">Samba</ulink> (3.x or 4.x, 4.1 recommended)</para></listitem>
- <listitem><para><ulink url="http://http://www.gnu.org/software/grep/">GNU grep</ulink></para></listitem>
- <listitem><para><ulink url="http://www.gnu.org/software/gawk/">GNU awk (gawk)</ulink> or similar</para></listitem>
- <listitem><para><ulink url="http://www.gnu.org/software/sed/">GNU sed</ulink></para></listitem>
- <listitem><para><ulink url="http://www.gnu.org/software/findutils/">GNU findutils (xargs)</ulink></para></listitem>
- <listitem><para>Support of the /proc file system compiled into your kernel (&Linux;)</para></listitem>
+ <listitem><para><ulink url="http://www.samba.org">Samba</ulink> (3.x or 4.x, 4.x recommended)</para></listitem>
</itemizedlist>
<para>To enable full functionality, you may also want to install these programs:</para>
<itemizedlist>
<listitem><para><ulink url="http://rsync.samba.org">rsync</ulink></para></listitem>
</itemizedlist>
-<para>&smb4k; uses about 20 MB of memory to run, but this may vary depending on your platform and configuration.</para>
<para>The list of changes can be found in the <filename>ChangeLog</filename> file.</para>
</sect1>
+<!-- Appendix: Configuration, Compilation and Installation -->
+
<sect1 id="appendix_compilation">
<title>Configuration, Compilation and Installation</title>
<para>This section describes the configuration, compilation and installation of &smb4k;. Make sure, you have read the <link linkend="appendix_requirements">Requirements</link> page before you start.</para>
<para><ulink url="https://sourceforge.net/projects/smb4k/files">Download</ulink> the version of Smb4K you are interested in and extract the source tarball:</para>
-<para><screen><prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput></screen></para>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput>
+ </screen>
+</para>
<para>Replace x.y.z with the version number. Change into the source code directory and create a <filename class="directory">build</filename> directory:</para>
-<para><screen><prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">smb4k-x.y.z</filename></userinput>
-<prompt>$</prompt> <userinput><command>mkdir</command> <filename class="directory">build</filename></userinput></screen></para>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">smb4k-x.y.z</filename></userinput>
+ <prompt>$</prompt> <userinput><command>mkdir</command> <filename class="directory">build</filename></userinput>
+ </screen>
+</para>
<para>Change into the <filename class="directory">build</filename> directory and configure the source code:</para>
-<para><screen><prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
-<prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput></screen></para>
-<para>If you want to compile Smb4K with debug symbols, replace Release by Debug. There are also some &smb4k; specific arguments you might be interested in:</para>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
+ <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
+ </screen>
+</para>
+<para>If Smb4K cannot find some shared libraries after the installation (⪚ if you are using Kubuntu 16.04), it is necessary to add the <option>-DKDE_INSTALL_PLUGINDIR</option> argument to the command line above:</para>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
+ <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
+ -DKDE_INSTALL_PLUGINDIR=`qtpaths --plugin-dir` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
+ </screen>
+</para>
+<para>If you want to compile Smb4K with debug symbols, replace Release by Debug. You should consider this if you experience &ie; a crash and want to either debug &smb4k; yourself or report a bug including a full backtrace</para>
+<para>There are also some &smb4k; specific arguments you might be interested in:</para>
<para>
<informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
@@ -4568,14 +4584,17 @@ of the &kde; Fundamentals.</para>
</informaltable>
</para>
<para>After the configuration, compile and install &smb4k;:</para>
-<para><screen><prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput></screen></para>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput>
+ </screen>
+</para>
<para>If you want to be able to remove &smb4k; with your package manager later on, use <application>checkinstall</application> instead of <command>make install</command>. The package should be present in your distribution's repository. Run:</para>
-<para><screen><prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput></screen></para>
-<note>
-<para>If you experience a crash or similar and want to either debug &smb4k; yourself or report a bug including a full backtrace, please compile the program with debugging symbols. The procedure is similar to the one described above except that the <application>cmake</application> command has to look like this:</para>
-<screen><prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`<command>kde4-config</command> --prefix` -DCMAKE_BUILD_TYPE=debugfull ..</userinput></screen>
-<para>Compile and install the program as stated above. If you found the cause for the bug, please let us <link linkend="reporting_bugs">know</link>.</para>
-</note>
+<para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput>
+ </screen>
+</para>
</sect1>
</appendix>
</book>
More information about the kde-doc-english
mailing list