Git commit b52247fd9772f63ac66eb07b3dcd709e0db1ba3e by Alexander Reinholdt. Committed on 08/01/2017 at 11:35. Pushed by areinholdt into branch 'master'.
Fixed several format issues in the handbook. M +42 -38 doc/index.docbook https://commits.kde.org/smb4k/b52247fd9772f63ac66eb07b3dcd709e0db1ba3e diff --git a/doc/index.docbook b/doc/index.docbook index 95e763f..4d0a705 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1474,14 +1474,18 @@ client ipc max protocol = NT1 <itemizedlist> <listitem><para>Configure, compile and install &smb4k; according to the directions given in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> section of the appendix.</para></listitem> <listitem><para>After installation, link (or copy) the file <filename>net.sourceforge.smb4k.mounthelper.conf</filename> from the <filename class="directory">examples</filename> directory to the right location:</para> - <para><screen><userinput><prompt>$</prompt> <command>cd</command> <filename class="directory">/usr/pkg/etc/dbus-1/system.d/</filename></userinput> - <userinput><prompt>$</prompt> <command>sudo ln</command> -s \ - <filename>/usr/pkg/share/examples/kde4-dbus/net.sourceforge.smb4k.mounthelper.conf</filename> .</userinput></screen></para></listitem> + +<screen> +<userinput><prompt>$</prompt> <command>cd</command> <filename class="directory">/usr/pkg/etc/dbus-1/system.d/</filename></userinput> +<userinput><prompt>$</prompt> <command>sudo ln</command> -s \ + <filename>/usr/pkg/share/examples/kde4-dbus/net.sourceforge.smb4k.mounthelper.conf</filename> .</userinput> +</screen> + </listitem> <listitem><para>Edit the file <filename>/usr/pkg/etc/PolicyKit/PolicyKit.conf</filename> and add the following paragraph in the <config version="0.1"> section:</para> <programlisting> <match action="org.kde.smb4k.mounthelper.*"> -<return result="yes"> + <return result="yes"> </match></programlisting> <para>This will allow everyone to mount and unmount remote Samba shares with &smb4k;.</para></listitem> @@ -3589,33 +3593,33 @@ client ipc max protocol = NT1 <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> + +<screen> +<prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput> +</screen> + <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> + +<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>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=`qtpaths --install-prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput> - </screen> - </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>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> + +<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>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> @@ -3644,17 +3648,17 @@ client ipc max protocol = NT1 </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> + +<screen> +<prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput> +</screen> + <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> + +<screen> +<prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput> +</screen> + </sect1> </appendix> </book> \ No newline at end of file
