Git commit e36ce88a93dcea792d328b29e524edef4faef19a by Alexander Reinholdt. Committed on 05/03/2017 at 11:02. Pushed by areinholdt into branch 'master'.
Updated handbook with a patch send by Burkhard Lück. M +18 -20 doc/index.docbook https://commits.kde.org/smb4k/e36ce88a93dcea792d328b29e524edef4faef19a diff --git a/doc/index.docbook b/doc/index.docbook index 45eea17..958f05d 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -27,8 +27,8 @@ <holder>Alexander Reinholdt</holder> </copyright> <legalnotice>&underFDL;</legalnotice> - <date>2017-02-04</date> - <releaseinfo>&smb4k; 2.0.0</releaseinfo> + <date>2017-03-03</date> + <releaseinfo>&smb4k; 2.0.0</releaseinfo><!--FIXME change releaseinfo number--> <abstract> <para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility.</para> </abstract> @@ -72,12 +72,10 @@ <listitem><para>Ability to define custom options for individual servers and shares</para></listitem> <listitem><para>Laptop support through the Solid hardware device framework</para></listitem> <listitem><para>Wake-On-LAN capabilities</para></listitem> -<!-- <listitem><para>&plasmoid; for desktop integration</para></listitem> --> + <listitem><para>&plasmoid; for desktop integration</para></listitem> <listitem><para>Profiles for different network neighborhood setups</para></listitem> </itemizedlist> - <note><para>The plasmoid has not been ported to &plasma; and QtQuick 2 yet. Thus, it has been disabled in this release. We are currently working on bringing this functionality back.</para></note> - <para>If you encounter problems while using &smb4k;, please visit our <ulink url="https://sourceforge.net/p/smb4k/wiki/Home/";>wiki</ulink> first. If you cannot find your problem described there, please post a help request to our <ulink url="https://sourceforge.net/p/smb4k/discussion/help/";>Help</ulink> forum. In case you find a bug, please report it to our <ulink url="https://bugs.kde.org/enter_bug.cgi?format=guided&product=smb4k";>bug tracker</ulink>.</para> <para>For discussions about &smb4k;-related topics there is the <ulink url="https://sourceforge.net/p/smb4k/discussion/general/";>General Discussion</ulink> forum and we invite every user to participate.</para> </chapter> @@ -98,7 +96,7 @@ <para>After the installation, you can run &smb4k; either from the K menu or from the command prompt by typing <screen><prompt>$</prompt> <userinput><command>smb4k</command></userinput></screen></para> <para>&smb4k; does not take any arguments, except those that are known to all &kde; applications.</para> - <!--<para>&smb4k; also comes with a <link linkend="plasmoid">&plasmoid;</link> for better desktop integration. It can be added as widget to the desktop or the panel.</para>--> + <para>&smb4k; also comes with a <link linkend="plasmoid">&plasmoid;</link> for better desktop integration. It can be added as widget to the desktop or the panel.</para> <para>If your system is missing some of the programs &smb4k; needs to operate properly, it notifies the user:</para> <screenshot id="notification_missing_program"> @@ -1062,7 +1060,7 @@ Using Smb4K : The Plasmoid --> -<!--<sect1 id="plasmoid"> +<sect1 id="plasmoid"> <title>The &plasmoid;</title> <para>&smb4k; comes with a &plasmoid; that can be added as a widget to the desktop or the panel. It consists of four views that are arranged as tabs: <guilabel>Network Neighborhood</guilabel>, <guilabel>Mounted Shares</guilabel>, <guilabel>Bookmarks</guilabel>, and <guilabel>Profiles</guilabel>.</para> @@ -1073,13 +1071,13 @@ <imageobject><imagedata fileref="plasmoid.png" format="PNG" /></imageobject> <textobject><phrase>Screenshot of the plasmoid</phrase></textobject> </mediaobject> - </screenshot>--> + </screenshot> <!-- Using Smb4K : The Plasmoid : Network Neighborhood Tab --> -<!-- <sect2 id="plasmoid_network_neighborhood"> + <sect2 id="plasmoid_network_neighborhood"> <title>Network Neighborhood Tab</title> <para>On the <guilabel>Network Neighborhood</guilabel> page the network items are arranged in a list view:</para> @@ -1096,13 +1094,13 @@ <para>For hosts and shares, to the right of the name of the network item some action buttons are arranged. For hosts, there is one button with that you can open the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog. For shares, there is an additional button with that you can <link linkend="bookmarks_adding">add the share to the bookmarks</link>. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> <para>Besides the already mentioned <guibutton>Up</guibutton> button, the toolbar contains three more entries: <guibutton>Rescan</guibutton>, <guibutton>Abort</guibutton> and <guibutton>Mount Dialog</guibutton>. With them you can do a rescan, abort any running action or open the <link linkend="network_neighborhood_browser_mounting">dialog for "manual" mounts</link>.</para> <note><para>In the current development state, the &plasmoid; is not able to handle the <link linkend="configuration_network_periodic_scanning">automatic scanning feature</link>, &smb4k; provides. Funny things will happen, if you use it with the &plasmoid; and will probably render it mostly unusable.</para></note> - </sect2>--> + </sect2> <!-- Using Smb4K : The Plasmoid : Mounted Shares Tab --> -<!-- <sect2 id="plasmoid_mounted_shares"> + <sect2 id="plasmoid_mounted_shares"> <title>Mounted Shares Tab</title> <para>On the <guilabel>Mounted Shares</guilabel> page all mounted shares are listed:</para> @@ -1116,13 +1114,13 @@ <para>Right to the name of the share and its host, two action buttons are arranged. The first one is for <link linkend="bookmarks_adding">adding a bookmark</link> and the second for unmounting the share. The action buttons are transparent by default and change to opaque when you move your mouse over them. By left clicking you initiate the respective action.</para> <para>The toolbar only contains the <guibutton>Unmount All</guibutton> action that lets you unmount all shares at once.</para> - </sect2>--> + </sect2> <!-- Using Smb4K : The Plasmoid : Bookmarks Tab --> -<!-- <sect2 id="plasmoid_bookmarks"> + <sect2 id="plasmoid_bookmarks"> <title>Bookmarks Tab</title> <para>On the <guilabel>Bookmarks</guilabel> page, the bookmark groups and bookmarks defined for the currently active profile are listed:</para> @@ -1137,13 +1135,13 @@ <para>Bookmarked shares can be mounted by left clicking the respective bookmark. Bookmark groups can be entered the same way.</para> <para>To edit or remove the bookmarks, you can press the <guibutton>Edit</guibutton> action button in the toolbar to open the <link linkend="bookmarks_editor">Bookmark Editor</link>. To get back to the toplevel the <guibutton>Back</guibutton> button is used.</para> - </sect2>--> + </sect2> <!-- Using Smb4K : The Plasmoid : Profiles Tab --> -<!-- <sect2 id="plasmoid_profiles"> + <sect2 id="plasmoid_profiles"> <title>Profiles Tab</title> <para>On the <guilabel>Profiles</guilabel> page, all defined profiles are listed. The currently active one is marked with an appended <guilabel>(active)</guilabel> label.</para> @@ -1159,7 +1157,7 @@ <para>You can activate a certain profile by clicking it.</para> <para>Profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_profiles">configuration dialog</link>.</para> </sect2> -</sect1>--> +</sect1> <!-- Using Smb4K : Bookmarks @@ -1175,7 +1173,7 @@ <sect2 id="bookmarks_adding"> <title>Adding Bookmarks</title> - <para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link><!-- Remove the following in favor of the commented part --> and the <link linkend="shares_view">shares view</link><!--, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>-->. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. <!--In the &plasmoid;, you click the respective bookmark action next to the item's name.--> A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> + <para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link><!-- Remove the following in favor of the commented part --> and the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. In the &plasmoid;, you click the respective bookmark action next to the item's name. A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> <screenshot> <screeninfo>Screenshot of the bookmarks addition dialog</screeninfo> @@ -1245,7 +1243,7 @@ <para>All other entries are either group submenus or shares that do not belong to a group. All entries are listed alphabetically and the bookmarks may either appear with their UNC address or descriptive label. By clicking a bookmark, the respective share is mounted. If a bookmarked share is mounted on the system, the bookmark entry is disabled.</para> <para>For each group there is a submenu. It contains all bookmarks belonging to the group and a <guimenuitem>Mount All Bookmarks</guimenuitem> menu item. The latter one can be used to mount all bookmarks in that submenu at once.</para> - <para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. <!--The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu.--> The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="bookmarks_editor">bookmark editor</link>.</para> + <para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu. The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="bookmarks_editor">bookmark editor</link>.</para> </sect2> <!-- @@ -4043,7 +4041,7 @@ client ipc max protocol = NT1 <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 <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> + <para>&smb4k; depends on the following <ulink url="http://www.qt.io";>&Qt;</ulink> (≥ 5.7.0) and <ulink url="http://www.kde.org";>&kf5;</ulink> (≥ 5.31.0) modules:</para> <itemizedlist> <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> @@ -4116,7 +4114,7 @@ client ipc max protocol = NT1 <row> <entry>-DINSTALL_PLASMOID=yes|no</entry> <entry align="center">1.1.0</entry> - <entry>Install the plasmoid. KDE SC 4.10 or higher is required. This is on by default, if the right KDE version is detected.</entry> + <entry>Install the plasmoid. KDE SC 4.10 or higher is required. This is on by default, if the right KDE version is detected.</entry><!--FIXME KF5 version?--> </row> </tbody> </tgroup>
