Commit 2070fa93 authored by Alexander Reinholdt's avatar Alexander Reinholdt
Browse files

Started to update the handbook.

parent a166d732
......@@ -33,8 +33,8 @@
<holder>Alexander Reinholdt</holder>
</copyright>
<legalnotice>&underFDL;</legalnotice>
<date>2019-05-19</date>
<releaseinfo>&smb4k; 3.0.1</releaseinfo><!--FIXME change releaseinfo number-->
<date>2020-11-24</date>
<releaseinfo>&smb4k; 3.1.0</releaseinfo><!--FIXME change releaseinfo number-->
<abstract>
<para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility.</para>
</abstract>
......@@ -52,11 +52,11 @@
<chapter id="introduction" >
<title>Introduction</title>
<para>This handbook describes &smb4k; 3.0.x and to some extent earlier versions.</para>
<para>This handbook describes &smb4k; 3.1.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>
<itemizedlist>
<listitem><para>Scanning for (active) workgroups, hosts, and shares</para></listitem>
<listitem><para>Scanning for (active) workgroups, hosts, and shares using Samba's client library, DNS Service Discovery (DNS-SD) and, optionally, Web Services Dynamic Discovery (WS-Discovery)</para></listitem>
<listitem><para>Support of the &CIFS; (&Linux;) and SMBFS (BSD) file system</para></listitem>
<listitem><para>Mounting and unmounting of shares</para></listitem>
<listitem><para>Access to the files of a mounted share using a file manager or terminal</para></listitem>
......@@ -80,7 +80,7 @@
<listitem><para>Profiles for different network neighborhood setups</para></listitem>
</itemizedlist>
<para>If you encounter problems while using &smb4k;, 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&amp;product=smb4k">bug tracker</ulink>. 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>
<para>If you encounter problems while using &smb4k;, 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&amp;product=smb4k">bug tracker</ulink>. 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>
<!--
......@@ -99,10 +99,6 @@
<para>You can either launch &smb4k; from the K menu or from <ulink url="https://userbase.kde.org/Plasma/Krunner">&krunner;</ulink> by typing <userinput><command>smb4k</command></userinput>. &smb4k; comes with a <link linkend="plasmoid">&plasmoid;</link> for better desktop integration. It can be added as widget to the desktop or panel.</para>
<note>
<para>If you are using &Samba; version 4.7 or above, you most likely have to change a setting in &Samba;'s configuration file to make browsing work. Have a look at the <link linkend="special_remarks_problems_browsing_samba_47">Special Remarks</link> section to find out what has to be adjusted.</para>
</note>
<para>If the system is missing some of the programs &smb4k; needs to operate properly, it notifies the user:</para>
<screenshot id="notification_missing_program">
......@@ -133,10 +129,10 @@
</mediaobject>
</screenshot>
<para>&smb4k; comes with a toolbar that contains some of the main actions, like <guimenuitem>Configure &smb4k;</guimenuitem> and <guimenuitem>Quit</guimenuitem>. It also dynamically loads the actions of the dock widget that currently has got the focus. For additional information, please have a look at the sections discussing the <link linkend="network_neighborhood_browser">network neighborhood browser</link> and <link linkend="shares_view">mounted shares view</link>.</para>
<para>The toolbar contains some of the main actions, like <guimenuitem>Configure &smb4k;</guimenuitem> and <guimenuitem>Quit</guimenuitem>. It also dynamically loads the actions of the dock widget that currently has got the focus. For additional information, please have a look at the sections discussing the <link linkend="network_neighborhood_browser">network neighborhood browser</link> and <link linkend="shares_view">mounted shares view</link>.</para>
<para>The status bar gives some information about the current status of &smb4k;. If the application is processing a user request (&eg; mounting a share), a descriptive message is displayed in the leftmost section and a progress bar is shown with a busy indicator. The two icons on the right hand side indicate if there are shares mounted (network folder icon) and the status of the authentication system (wallet or key icon).</para>
<para>If the dock widgets are arranged as tabs, the user gets additional visual feedback. Each time a share is mounted or unmounted, the <guilabel>Mounted Shares</guilabel> tab is highlighted for a few seconds.</para>
<para>The main window is highly configurable. You can hide or show all tabbed widgets (<menuchoice><guimenu>Settings</guimenu><guimenuitem>Dock Widgets</guimenuitem></menuchoice>). They can also be dragged around with the mouse and docked to different areas in the main window. You can even detach them from the main window. The status bar and the toolbars can be hidden/shown by toggling the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice> and the ones under <menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice>, respectively.</para>
<para>The main window is highly configurable. You can hide or show all tabbed widgets (<menuchoice><guimenu>Settings</guimenu><guimenuitem>Dock Widgets</guimenuitem></menuchoice>). They can also be dragged around with the mouse and docked to different areas in the main window. You can even detach them from the main window. The status bar and the toolbars can be hidden or shown by toggling the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice> and the ones under <menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice>, respectively.</para>
</sect1>
<!--
......@@ -1370,23 +1366,6 @@
<sect1 id="special_remarks">
<title>Special Remarks</title>
<!--
Using Smb4K : Special Remarks : Problems Browsing the Network Neighborhood with &Samba; 4.7 and above
-->
<sect2 id="special_remarks_problems_browsing_samba_47">
<title>Problems Browsing the Network Neighborhood with &Samba; 4.7 and above</title>
<para>Since version 2.9.71, &smb4k; is using &Samba;'s client library (<application>libsmbclient</application>) to browse and search the network neighborhood and print files. With the &Samba; 4.7 release, the default protocol version has been set to SMB3 by the &Samba; team. Unfortunately, &Samba;'s client library cannot handle it correctly at the moment and browsing the network neighborhood will fail. For this reason, users of Samba 4.7 and above need to add the following setting to the [global] section of the <filename>smb.conf</filename> file to force &Samba; to use SMB1 (NT1) and, thus, fix the browsing of the network neighborhood:</para>
<programlisting>[global]
...
client max protocol = NT1
...</programlisting>
<para>If you need help, you can consult the Samba Wiki's <ulink url="https://wiki.samba.org/index.php/User_Documentation">User Documentation</ulink> section for further information.</para>
</sect2>
<!--
Using Smb4K : Special Remarks : Denied Privilege Escalation
-->
......
doc/main_window.png

98.3 KB | W: | H:

doc/main_window.png

69 KB | W: | H:

doc/main_window.png
doc/main_window.png
doc/main_window.png
doc/main_window.png
  • 2-up
  • Swipe
  • Onion skin
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment