<?xml version="1.0" ?>
<?xml-stylesheet href="index.css" type="text/css"?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
  <!ENTITY smb4k "<application>Smb4K</application>">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
  <!ENTITY CIFS "<acronym>CIFS</acronym>">
  <!ENTITY SMB3 "<acronym>SMB3</acronym>">
  <!ENTITY Samba "<application>Samba</application>">
  <!ENTITY kdbusaddons "<application>KDBusAddons</application>">
]>

<book id="smb4k" lang="&language;" >
<title>The &smb4k; Handbook</title>

<bookinfo>
  <authorgroup>
    <author>
      <firstname>Alexander</firstname>
      <othername></othername>
      <surname>Reinholdt</surname>
      <affiliation>
        <address>
          <email>alexander.reinholdt AT kdemail.net</email>
        </address>
      </affiliation>
    </author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
  </authorgroup>

  <copyright>
    <year>2005-2024</year>
    <holder>Alexander Reinholdt</holder>
  </copyright>

  <legalnotice>&underFDL;</legalnotice>
  <date>2024-12-08</date>
  <releaseinfo>&smb4k; 4.0.0</releaseinfo><!--FIXME change releaseinfo number-->

  <abstract>
    <para>&smb4k; is an advanced network neighborhood browser and &Samba; share mounting utility.</para>
  </abstract>

  <keywordset>
    <keyword>KDE</keyword>
    <keyword>Smb4K</keyword>
    <keyword>Samba</keyword>
  </keywordset>
</bookinfo>

<!-- 
      Introduction 
  -->

<chapter id="introduction" >
  <title>Introduction</title>

  <para>This handbook describes &smb4k; 4.0 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 &Windows;-dominated network environment:</para>

  <itemizedlist>
    <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; and &SMB3; file system under &Linux; as well as the SMBFS file system under BSD</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>
    <listitem><para>Auto-detection of external mounts and unmounts</para></listitem>
    <listitem><para>Remounting of previously used shares on program start</para></listitem>
    <listitem><para>Various information about remote network items and mounted shares</para></listitem>
    <listitem><para>Network search</para></listitem>
    <listitem><para>Preview of the contents of a remote share</para></listitem>
    <listitem><para>Default login</para></listitem>
    <listitem><para>Special handling of home shares</para></listitem>
    <listitem><para>Ability to bookmark favorite shares</para></listitem>
    <listitem><para>System tray widget</para></listitem>
    <listitem><para>Support of advanced mount options</para></listitem>
    <listitem><para>Support of printer shares</para></listitem>
    <listitem><para>Support of several secure storage solutions for the login credentials via QtKeychain</para></listitem>
    <listitem><para>Synchronization of a remote share with a local copy, and vice versa</para></listitem>
    <listitem><para>Ability to define custom settings for individual servers and shares</para></listitem>
    <listitem><para>Hardware support through the &solid; device integration framework, the &kdbusaddons; convenience classes and the &Qt; Network module</para></listitem>
    <listitem><para>Wake-On-LAN capabilities</para></listitem>
    <listitem><para>&plasmoid; for desktop integration</para></listitem>
    <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>
</chapter>

<!-- 
      Using Smb4K 
  -->

<chapter id="using_smb4k">
  <title>Using &smb4k;</title>

<!-- 
      Using Smb4K : Running Smb4K 
  -->

  <sect1 id="running_smb4k" >
    <title>Running &smb4k;</title>
    
    <para>You can either launch &smb4k; from the <ulink url="https://userbase.kde.org/Plasma/Kickoff">application launcher</ulink> 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 that can be added as a widget to the desktop or panel.</para>

    <para>If &smb4k; encounters a problem on start-up or while running, the user will be notified. For the solution of some common problems see the <link linkend="trouble_shooting">Trouble Shooting</link> section.</para>
  </sect1>

<!-- 
      Using Smb4K : Main Window 
  -->

  <sect1 id="mainwindow_overview">
    <title>The Main Window</title>
  
    <para>On the first start-up, the main window of &smb4k; looks similar to the one shown below. The network neighborhood browser (<guilabel>Network Neighborhood</guilabel>) and the mounted shares view (<guilabel>Mounted Shares</guilabel>) are arranged in tabs. Above them the menu bar and tool bar are located, and below them there is the status bar.</para>
    
    <screenshot id="mainwindow_overview_screenshot">
      <screeninfo>Screenshot of the main window</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="main_window.png" format="PNG" /></imageobject>
        <textobject><phrase>The main window</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>The tool bar 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 the focus. For additional information, please take 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>, respectively.</para>
    <para>The status bar provides 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 icon on the right side indicates whether shares are mounted.</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 via <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 tool bar can be hidden or shown by toggling the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice> and  <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Toolbar</guimenuitem></menuchoice>, respectively.</para>
  </sect1>

<!-- 
      Using Smb4K : The Network Neighborhood Browser 
  -->

  <sect1 id="network_neighborhood_browser">
    <title>The Network Neighborhood Browser</title>

    <para>The <guilabel>Network Neighborhood</guilabel> browser contains all network items &#8212; &ie; domains or workgroups, servers, and shares &#8212; &smb4k; was able to find. They are organized in a network tree, which you can navigate through by either clicking on the control next to the item's name or by executing the item itself.</para>
    <para>In the network tree, the master browser in each workgroup or domain is highlighted by a blue font color, if it was detected (&eg; when using DNS-SD, the master browser of a &Windows; domain is not recognized). Mounted shares are marked with the respective folder icon and an italic font.</para>

    <screenshot>
      <screeninfo>Screenshot of the network neighborhood browser</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="network_neighborhood_browser.png" format="PNG" /></imageobject>
        <textobject><phrase>The network neighborhood browser</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>The selection of multiple network items is supported. So, it is possible to &eg; mount or preview several shares at once.</para>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Browsing 
  -->

    <sect2 id="network_neighborhood_browser_browsing">
      <title>Browsing</title>

      <para>&smb4k; automatically scans the network neighborhood for active workgroups and domains on start-up, and presents them in the network neighborhood browser. For this purpose it uses &Samba;'s client library, <ulink url="https://en.wikipedia.org/wiki/Zero-configuration_networking#DNS-SD">DNS Service Discovery (DNS-SD)</ulink> and, optionally, <ulink url="https://en.wikipedia.org/wiki/WS-Discovery">Web Services Dynamic Discovery (WS-Discovery)</ulink>. The way &smb4k; browses the network neighborhood can be adjusted on the <link linkend="configuration_page_network_basic_settings_browse_settings"><guilabel>Network</guilabel> configuration page</link>.</para>
      <para>&smb4k; uses a traditional scan mode, where initially only workgroups and domains are looked up and scans are only made when necessary &#8212; &ie;, when you execute a network item. Due to the use of DNS-SD, you will most likely find a domain called <emphasis>LOCAL</emphasis> in the network neighborhood browser. This is the default local DNS domain used by services like <ulink url="https://en.wikipedia.org/wiki/Avahi_(software)">Avahi</ulink> and not an actual &Windows; domain. Opening a domain or workgroup item shows the servers belonging to it. If you want to access the shares of one of the servers, you need to open the desired server.</para>
      <note>
        <para>If you are using DNS Service Discovery and the Zeroconf daemon (Avahi) is not running, &smb4k; shows an error notification. For details see the <link linkend="trouble_shooting_zeroconf">Trouble Shooting</link> section.</para>
      </note>
      <para>There is also the possibility to wake up sleeping servers prior to scanning the network neighborhood (Wake-On-LAN). If this feature is enabled, &smb4k; sends a magic packet to each server that is to be awakened, then waits the defined time until it starts to look up the workgroups and domains. The Wake-On-LAN setting can be turned on in the <link linkend="configuration_page_network_advanced_settings_wake_on_lan">configuration dialog</link>. The servers that should be awakened must be defined in the <link linkend="network_neighborhood_browser_defining_custom_settings">Custom Settings</link> editor.</para>
    </sect2>
    
<!--
      Using Smb4K : The Network Neighborhood Browser : Searching
  -->
    
    <sect2 id="network_neighborhood_browser_searching">
      <title>Searching</title>
      
      <para>To search the network neighborhood for shares that contain a certain search item, execute the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>F</keycap></keycombo></shortcut><guimenuitem>Search</guimenuitem></menuchoice> action (see also the <link linkend="network_neighborhood_browser_actions_popup_menu">Actions and Popup Menu</link> section below). The search tool bar opens at the bottom of the network neighborhood browser.</para>
      
      <screenshot>
        <screeninfo>Screenshot of the network neighborhood browser with visible search tool bar</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="network_neighborhood_browser_searching.png" format="PNG" /></imageobject>
          <textobject><phrase>The network neighborhood browser with visible search tool bar</phrase></textobject>
        </mediaobject>
      </screenshot>
      
      <para>Enter the search term in the line edit and press the &Enter; key, or click the <guibutton>Search</guibutton> button. &smb4k; starts to search the entire network neighborhood. When the search is finished, all shares matching the search term are highlighted (selected). If you would like to do something with <emphasis>all</emphasis> discovered shares (&eg; mount or preview), you can do so now. Otherwise, you can use the <guibutton>Up</guibutton> and <guibutton>Down</guibutton> buttons to jump to the individual search results. The <guibutton>Clear</guibutton> button can be used to clear the search. To close the search tool bar, press the <guibutton>Close</guibutton> button.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Actions and Popup Menu 
  -->

    <sect2 id="network_neighborhood_browser_actions_popup_menu">
      <title>Actions and Popup Menu</title>

      <para>Several actions are defined for the network neighborhood browser. They are present in the menu bar under <guimenu>Network</guimenu>, in the tool bar, and in the popup menu. The following actions are available:</para>
    
      <variablelist>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycap>F5</keycap></shortcut>
              <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Scan the whole network neighborhood, the highlighted workgroup/domain, or the computer for new entries. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network scan is running.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut>
              <guimenuitem>Abort</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Abort any running process of the network neighborhood browser. This action is invisible by default and will only be visible when a network scan is running.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>F</keycap></keycombo></shortcut>
              <guimenuitem>Search</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para><link linkend="network_neighborhood_browser_searching">Search the network neighborhood</link> for a specified term. Activating this action opens the search tool bar, where you can enter the search term and start the search.</para>
          </listitem>
        </varlistentry>        
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut>
              <guimenuitem>Add Bookmark</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para><link linkend="bookmarks_adding">Add a bookmark</link> to the selected remote shares. This action is disabled if there are no shares selected.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut>
              <guimenuitem>Add Custom Settings</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the <link linkend="custom_settings">Custom Settings</link> editor where you can set several custom settings for each selected server and share. If a workgroup or no item is selected, this menu entry is disabled.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut>
              <guimenuitem>Open Mount Dialog</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for mounting shares using their address (URL or UNC). This feature may be needed if &smb4k; cannot find the server from which you want to mount a certain shared resource.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut>
              <guimenuitem>Authentication</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the <link linkend="network_neighborhood_browser_authentication">password dialog</link> where you can provice the user name and password for each selected server and share. If a workgroup or no item is selected, this action is disabled.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut>
              <guimenuitem>Preview</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para><link linkend="network_neighborhood_browser_previewing">Preview</link> the contents of the selected remote shares. This action is only enabled if shares are selected. Printer shares cannot be previewed.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut>
              <guimenuitem>Print File</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para><link linkend="network_neighborhood_browser_printing">Print</link> a file on a remote printer. This action is only available if at least one printer share is selected.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut>
              <guimenuitem>Mount</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Mount the selected remote shares. This action is visible by default as long as you do not select mounted shares (see below). If you select anything different than a share with type "Disk" or "IPC", this action is disabled.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut>
              <guimenuitem>Unmount</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Unmount the selected shares. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action if at least one mounted share is selected.</para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>In the network neighborhood browser you can right click to open the popup menu to access all available actions. Depending on the position where you clicked (on a network item or on the viewport), some of them may be disabled. The screenshot below shows the popup menu opened on a remote share.</para>

      <screenshot>
        <screeninfo>Screenshot of the popup menu of the network neighborhood browser</screeninfo>
          <mediaobject>
          <imageobject>
            <imagedata fileref="network_neighborhood_browser_popup_menu.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>The popup menu of the network neighborhood browser</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Tooltips 
  -->

    <sect2 id="network_neighborhood_browser_tooltips">
      <title>Tooltips</title>

      <para>For each network item, a tooltip is provided that contains various information like the name of the workgroup and master browser (if available), the name and IP address of the host, the name of the share, &etc;</para>
      <para>The tooltips can be disabled in the <link linkend="configuration_page_user_interface_network">configuration dialog</link>.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Mounting a Share 
  -->

    <sect2 id="network_neighborhood_browser_mounting">
      <title>Mounting Shares</title>

      <para>There are three options available to mount a remote share:</para>

      <orderedlist>
        <listitem><para>Execute the icon representing the remote share in the network neighborhood browser. (Depending on your &kde; settings, this is done by either single or double clicking the icon.)</para></listitem>
        <listitem><para>Select the remote shares and click the <guimenuitem>Mount</guimenuitem> menu entry. Alternatively, you can press the <keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo> keyboard shortcut.</para></listitem>
        <listitem><para>Click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice> menu entry to open the mount dialog:</para>
        <screenshot>
          <screeninfo>Screenshot of the "Mount Share" dialog</screeninfo>
          <mediaobject>
            <imageobject><imagedata fileref="network_neighborhood_browser_mount_dialog.png" format="PNG" /></imageobject>
            <textobject><phrase>The "Mount Share" dialog</phrase></textobject>
          </mediaobject>
        </screenshot>
        <para>Here you can enter the location of the share as a <ulink url="http://en.wikipedia.org/wiki/Uniform_Naming_Convention#Uniform_Naming_Convention">Uniform Naming Convention (UNC)</ulink> address in the form <programlisting>//[USER@]SERVER/SHARE</programlisting> or <programlisting>\\[USER@]SERVER\SHARE</programlisting> or as an <ulink url="https://en.wikipedia.org/wiki/URL">URL</ulink> in the form <programlisting>[smb:]//[user@]server[:port]/share</programlisting> The <guibutton>OK</guibutton> button will be enabled and you can press it to mount the share. However, it is advisable to enter the IP address and the workgroup of the server, too. If you want to add the share to the bookmarks at the same time, click the <guibutton>Bookmark >></guibutton> button. The dialog will extend, so that you can tick the <guibutton>Add this share to the bookmarks</guibutton> check box and enter a label and category for the bookmark. See the section <link linkend="bookmarks">Bookmarks</link> for more details.</para></listitem>
      </orderedlist>

      <para>In this case a share is password protected, a <link linkend="network_neighborhood_browser_authentication">password dialog</link> will appear and you have to enter the correct user name (if not already present) and password. &smb4k; will proceed with mounting the share unless a wrong user name or password was entered. In that case, the authentication dialog will reappear. If the mount process was successful, the user will be shown a notification and the share will appear in the <link linkend="shares_view">Mounted Shares</link> view. If mounting fails, a notification with the error message that was returned by <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (&Linux;) or <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (BSD) will be displayed.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Printing Files 
  -->

    <sect2 id="network_neighborhood_browser_printing">
      <title>Printing Files on Remote Printers</title>

      <para>To print a file on a remote printer, open the print dialog by clicking the printer icon or choosing the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut><guimenuitem>Print File</guimenuitem></menuchoice> menu item.</para>
      <screenshot>
        <screeninfo>Screenshot of the print dialog</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="network_neighborhood_browser_print_dialog.png" format="PNG" /></imageobject>
          <textobject><phrase>The print dialog</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>The <guilabel>Information</guilabel> section displays various information about the printer. Under <guilabel>File and Settings</guilabel> you must provide the path to the file you want to print and the desired number of copies. Press <guibutton>Print</guibutton> to start the print process.</para>
      <para>&smb4k; currently supports PDF, Postscript, image, and text files. If you try to print a file with an unsupported mimetype, a notification with an error message will appear telling you the mimetype is not supported. In this case you should convert the file manually to Postscript or PDF and try again.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Previewing Shares 
  -->

    <sect2 id="network_neighborhood_browser_previewing">
      <title>Previewing Shares</title>
      
      <para>&smb4k; provides the ability to preview remote shares. If you click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut><guimenuitem>Preview</guimenuitem></menuchoice> menu entry, the contents of the selected remote share will be opened in a preview dialog.</para>
      <screenshot>
        <screeninfo>Screenshot of the preview dialog</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="network_neighborhood_browser_preview_dialog.png" format="PNG" /></imageobject>
          <textobject><phrase>The preview dialog</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>The preview dialog acts like a simple file manager. You can navigate through the contents of the remote share by clicking the folder icons in the list view. You can go one level up by using the <guibutton>Up</guibutton> button and reload the contents of the current folder by pressing the <guibutton>Reload</guibutton> button. The current location is displayed in the combo box on the right hand side. You can also access already visited folders with it.</para>
      <para>By default, the preview dialog does not show hidden folders and files. You can change this behavior in the <link linkend="configuration_page_network_basic_settings_behavior">configuration dialog</link>. File transfers and the like are not possible.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Providing Authentication Information 
  -->

    <sect2 id="network_neighborhood_browser_authentication">
      <title>Providing Authentication Information</title>

      <para>In case the server or share you want to access is password protected, a password dialog appears asking you for the user name and password. The same thing happens if you click the  <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut><guimenuitem>Authentication</guimenuitem></menuchoice> menu entry.</para>
      <screenshot>
        <screeninfo>Screenshot of the authentication dialog</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="network_neighborhood_browser_authentication_dialog.png" format="PNG" /></imageobject>
          <textobject><phrase>The authentication dialog</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>If a user name has already been provided, it will be shown in the respective field. If it is wrong, or no user name was provided, you have to enter one. The password, however, may be left blank. Clicking the <guibutton>OK</guibutton> button commits the data.</para>
      <para>Please note that you can also define default login information in the <link linkend="configuration_page_authentication">configuration dialog</link>.</para>
    </sect2>
    
<!-- 
      Using Smb4K : The Network Neighborhood Browser : Defining Custom Settings
  -->

    <sect2 id="network_neighborhood_browser_defining_custom_settings">
      <title>Defining Custom Settings</title>
      
      <para>For individual servers or shares you can define custom settings that deviate from the global settings. To do so, access the custom settings editor by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Add Custom Settings</guimenuitem></menuchoice> menu item. See the section <link linkend="custom_settings">Custom Settings</link> for more details.</para>
    </sect2>

<!-- 
      Using Smb4K : The Network Neighborhood Browser : Adding Bookmarks
  -->

    <sect2 id="network_neighborhood_browser_adding_bookmarks">
      <title>Adding Bookmarks</title>

      <para>A bookmark is added by selecting a remote share (only these can be bookmarked), and pressing the <keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo> keyboard shortcut or selecting the <guimenuitem>Add Bookmark</guimenuitem> menu item. The bookmark will then be accessible through the <guimenu>Bookmarks</guimenu> menu. See the section <link linkend="bookmarks">Bookmarks</link> for more details.</para>
      <para>The bookmarks can be used to mount remote shares.</para>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : The Mounted Shares View 
  -->

  <sect1 id="shares_view">
    <title>The Mounted Shares View</title>

    <para>In the shares view, you can interact with the shares mounted on your system.</para>

<!-- 
      Using Smb4K : The Mounted Shares View : Different Views 
  -->

    <sect2 id="shares_view_views">
      <title>Different Views</title>

      <para>&smb4k; comes with two alternative views: an icon view and a list view. They are both shown below. The icon view is the default.</para>
      <para>The icon view:</para>
      <screenshot>
        <screeninfo>Screenshot of the shares icon view</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="shares_view_icon_view.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>The shares icon view</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>The list view:</para>
      <screenshot>
        <screeninfo>Screenshot of the shares list view</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="shares_view_list_view.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>The shares list view</phrase>
          </textobject>
        </mediaobject>
      </screenshot>

      <para>You can switch between the two views by selecting the appropriate entry in the <guimenuitem>View Modes</guimenuitem> submenu of the tool bar, in the menu bar under <link linkend="mainwindow_overview"><guimenu>Shares</guimenu></link> or in the shares view's <link linkend="shares_view_actions_popup_menu">popup menu</link>.</para>
      <para>By default, only your own mounts are displayed. However, you can adjust &smb4k; to show all mounts in the <link linkend="configuration_page_mounting_basic_settings_behavior">configuration dialog</link>.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Actions and Popup Menu
  -->

    <sect2 id="shares_view_actions_popup_menu">
      <title>Actions and Popup Menu</title>

      <para>In the shares view, several actions are defined. They are present in the menu bar under <guimenu>Shares</guimenu>, in the tool bar, and in the popup menu. The following actions are available:</para>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>View Modes</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Choose the view mode from the submenu.</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Icon View</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The shares are shown in an icon view.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>List View</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The shares are shown in a list view.</para>
                </listitem>
              </varlistentry>
            </variablelist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut>
              <guimenuitem>Unmount</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Unmount the selected shares. If no share is selected in the shares view, this button is disabled.</para>
            <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut>
              <guimenuitem>Unmount All</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Unmount all shares at once. If you do not have any shares mounted, this button is disabled.</para>
            <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut>
              <guimenuitem>Add Bookmark</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Add bookmarks to the selected shares. This action is disabled if no share is selected.</para>
            <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut>
              <guimenuitem>Add Custom Settings</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the custom settings editor for the selected shares.</para>
            <para>Read the <link linkend="network_neighborhood_browser_defining_custom_settings">Custom Settings</link> section for more details.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>Y</keycap></keycombo></shortcut>
              <guimenuitem>Synchronize</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para><link linkend="shares_view_synchronization">Synchronize</link> a share with a local copy or vice versa. This action is only enabled if the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is installed and a share is selected.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>L</keycap></keycombo></shortcut>
              <guimenuitem>Open with Konsole</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the base folder of a share in &konsole;. This action is useful if you need to run shell scripts, &etc;</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>I</keycap></keycombo></shortcut>
              <guimenuitem>Open with File Manager</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the contents of a share in the default file manager.</para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>The popup menu includes all the actions that can be performed on a mounted share:</para>
      <screenshot>
        <screeninfo>Screenshot of the popup menu of the shares view</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="shares_view_popup_menu.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>The popup menu of the shares view</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>It can be opened by clicking the &RMB;.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Tooltips 
  -->

    <sect2 id="shares_view_tooltips">
      <title>Tooltips</title>

      <para>The tooltips provide information about the remote location of the share, the mountpoint, the user and group, the login, the file system, the disk usage, and the free disk space. If the share is <link linkend="shares_view_inaccessible_shares">inaccessible</link>, these values are marked as unknown.</para>
      <para>Tooltips are enabled by default. You can deactivate them in the <link linkend="configuration_page_user_interface_shares_view">configuration dialog</link>.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Inaccessible Shares 
  -->

    <sect2 id="shares_view_inaccessible_shares">
      <title>Inaccessible Shares</title>

      <para>&smb4k; periodically checks all mounted shares if they are still accessible. If an inaccessible share is encountered, it will be marked with a lock symbol and you will not be able to open or synchronize it anymore. Unmounting and adding a bookmark is still possible.</para>
      <note><para>The program might freeze for a short period of time due to an inaccessible share. It will recover afterwards.</para></note>
    </sect2>
    
<!--
      Using Smb4K : The Mounted Shares View : Shares Owned by Other Users
  -->
    
    <sect2 id="shares_view_foreign_shares">
      <title>Shares Owned by Other Users</title>
      
      <para>Shares owned by other users are only shown if you adjusted the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> to display them. In the default configuration, you are not allowed to unmount these shares, but you can <link linkend="configuration_page_mounting_basic_settings_behavior">change this behavior</link>, too.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Icons 
  -->

    <sect2 id="shares_view_icons">
      <title>Icons</title>

      <para>A mounted share is indicated by a small, corresponding symbol in the lower corner of the folder icon. This changes to a lock for shares that are not accessible. For shares that belong to another user, it is replaced by a warning sign.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Drag-and-Drop 
  -->

    <sect2 id="shares_view_drag_and_drop">
      <title>Drag-and-Drop</title>

      <para>&smb4k; supports drag-and-drop in the shares view. To transfer or link data to a share, drag the files and/or folders over the share icon and drop them there. A popup menu will open asking you what to do. Choose the appropriate action (copy, move or link).</para>
      <screenshot>
        <screeninfo>Screenshot of the shares view after the user dropped a file</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="shares_view_drop_popup_menu.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>A popup menu opened after the user dropped a file onto a share</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>To avoid the popup menu, press the &Shift; key for moving, the &Ctrl; key for copying and the <keycombo>&Ctrl;&Shift;</keycombo> key combination for linking while dragging and dropping. The transfer will only be successful if the share was mounted with read and write permissions.</para>
      <para>You can also drag and drop the whole share to the desktop or to another application (&eg; &dolphin;). Again, a popup menu will open asking you, what to do. When choosing the appropriate operation, please remember that under most circumstances moving and linking the share might not be a good idea.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Unmounting Shares 
  -->

    <sect2 id="shares_view_unmounting">
      <title>Unmounting Shares</title>

      <para>One or multiple selected shares may be unmounted by either clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> action, or by pressing its keyboard shortcut. By default, the ability to unmount a share is restricted to the ones that are owned by you. This behavior can be altered in the <link linkend="configuration_page_mounting_basic_settings_behavior">configuration dialog</link>. If you enabled the unmounting of shares that are owned by other users, you will be presented with a warning dialog prior to the actual unmount. If you proceed, the share will definitely be unmounted. So, please think twice before you decide to unmount those shares!</para>
      <para>&smb4k; provides the ability to force unmounting of shares (&Linux; only). This can be useful with inaccessible shares that cannot in be unmounted the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog. &smb4k; will then perform a <ulink url="man:/umount(8)">lazy unmount</ulink> on inaccessible shares.</para>
      <para>All shares can be unmounted at once by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut><guimenuitem>Unmount All</guimenuitem></menuchoice> action. Depending on your settings, this will also unmount foreign and inaccessible shares.</para>
      <para>After a successful unmount process, the user is <link linkend="notifications">notified</link>. If unmounting fails, a notification with the returned error message is shown.</para>
    </sect2>
    
<!--
      Using Smb4K : The Mounted Shares View : Defining Custom Settings
  -->
    
    <sect2 id="shares_view_adding_custom_settings">
      <title>Defining Custom Settings</title>
      
      <para>For selected shares, custom settings can be defined. Click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Add Custom Settings</guimenuitem></menuchoice> action to open the Custom Settings dialog. Read the <link linkend="custom_settings">Custom Settings</link> section for more details.</para>
    </sect2>
    
<!-- 
      Using Smb4K : The Mounted Shares View : Synchronization 
  -->

    <sect2 id="shares_view_synchronization">
      <title>Synchronization</title>

      <para>The <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo></shortcut><guimenuitem>Synchronize</guimenuitem></menuchoice> action opens the synchronization dialog. It offers the mount point of the share as the source and a path below the <link linkend="configuration_page_synchronization_basic_settings_default_destination">synchronization prefix</link> as the destination. To update the data on the share, you can swap the destination with the source by clicking the <guibutton>Swap Paths</guibutton> button.</para>
      <screenshot>
        <screeninfo>Screenshot of the synchronization input dialog</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="shares_view_synchronization_input_dialog.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>&URL; requester for sync'ing</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization and a progress dialog is shown that shows details about the transfer.</para>
      <screenshot>
        <screeninfo>Screenshot of the synchronization progress dialog</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="synchronization_progress.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>Progress dialog</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>The synchronization can be canceled at any time by pressing the stop button to the right of the progress bar.</para>
    </sect2>

<!-- 
      Using Smb4K : The Mounted Shares View : Opening a Share 
  -->

    <sect2 id="shares_view_opening_share">
      <title>Opening a Share</title>

      <para>&smb4k; provides two possibilities to open a mounted share:</para>
      <itemizedlist>
        <listitem><formalpara><title>Open a share with &konsole;</title>
          <para>You can open the mounted share in &konsole; by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut><guimenuitem>Open with Konsole</guimenuitem></menuchoice> action. This is useful if you need to run a shell script on the share or do something similar.</para>
        </formalpara></listitem>
        <listitem><formalpara><title>Open a share with the default file manager</title>
          <para>You can open the share in the default file manager (&eg; &dolphin;) by clicking the share icon or by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo></shortcut><guimenuitem>Open with File Manager</guimenuitem></menuchoice> action.</para>
        </formalpara></listitem>
      </itemizedlist>
      <note><para>If a share is marked as inaccessible, it cannot be opened.</para></note>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : The System Tray Widget 
  -->

  <sect1 id="systemtray">
    <title>The System Tray Widget</title>

<!-- 
      Using Smb4K : The System Tray Widget : Location and Usage 
  -->

    <sect2 id="systemtray_location_usage">
      <title>Location and Usage</title>

      <para>When &smb4k; is started, a status icon appears in the system tray. Its status is set to active if either workgroups or domains were discovered in your network neighborhood or remote shares were mounted. Otherwise it is set to inactive.</para>

      <screenshot>
        <screeninfo>Screenshot of the system tray widget</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="systemtray_location.png" format="PNG" /></imageobject>
          <textobject><phrase>System tray widget</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>You can minimize or restore the main window by left clicking the status icon. A right click brings up a popup menu that contains several items allowing you to work with the mounted shares, manage or mount your bookmarks, select the profile you want to use, and configure &smb4k; without opening the main window.</para>
    </sect2>

<!-- 
      Using Smb4K : The System Tray Widget : Menus and Menu Items 
  -->

    <sect2 id="systemtray_menus">
      <title>Menus and Menu Items</title>

      <para>The <guimenuitem>Mounted Shares</guimenuitem> menu lists all mounted shares and some actions that can be performed on them.</para>

      <screenshot>
        <screeninfo>Screenshot of the Mounted Shares popup menu of the system tray widget</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="systemtray_mounted_shares_menu.png" format="PNG" /></imageobject>
          <textobject><phrase>System tray widget's Mounted Shares menu</phrase></textobject>
        </mediaobject>
      </screenshot>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Unmount All</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Unmount all shares at once. Depending on your <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link>, &smb4k; attempts to unmount either only those shares that are owned by you or all that are listed.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    
      <para>For each mounted share you can open a submenu that contains the following entries. Read the shares view's <link linkend="shares_view_actions_popup_menu">Actions and Popup Menu</link> section for further information.</para>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Unmount</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Unmount the share.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Add the selected share to the bookmarks.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <guimenuitem>Add Custom Settings</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Open the custom settings editor for the selected share.</para>
            <para>For further information read the section about <link linkend="custom_settings">Custom Settings</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Synchronize</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Synchronize the mounted share with a local copy or vice versa.</para>
            <para>For further information read the section about <link linkend="shares_view_synchronization">Synchronization</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Open with &konsole;</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Open the base folder of the share in &konsole;.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Open with File Manager</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Open the contents of the share in the default file manager (&eg; &dolphin;).</para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>The <guimenuitem>Bookmarks</guimenuitem> menu contains all your bookmarks. Read the <link linkend="bookmarks">Bookmarks</link> section for further information.</para>

      <screenshot>
        <screeninfo>Screenshot of the Bookmarks menu of the system tray widget</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="systemtray_bookmarks_menu.png" format="PNG" /></imageobject>
          <textobject><phrase>System tray widget's Bookmarks menu</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>Its layout is as described <link linkend="bookmarks_menu">here</link>, except that the <guimenuitem>Add Bookmark</guimenuitem> menu item is not present.</para>
      <para>In the <guimenuitem>Profiles</guimenuitem> menu, all your <link linkend="profiles">profiles</link> are listed.</para>

      <screenshot>
        <screeninfo>Screenshot of the Profiles menu of the system tray widget</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="systemtray_profiles_menu.png" format="PNG" /></imageobject>
          <textobject><phrase>System tray widget's Profiles menu</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>You can activate a profile by clicking it. The profiles can be <link linkend="profiles">managed</link> in the <link linkend="configuration_page_profiles">configuration dialog</link>.</para>
      <para>These are the four additional menu entries:</para>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Open the <link linkend="network_neighborhood_browser_mounting">mount dialog</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Configure &smb4k;...</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Open the configuration dialog. See the section about <link linkend="configuration">the configuration</link> for a full list of available settings.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Minimize | Restore</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Hide (minimize) or show (restore) the main window. The text shown depends on the state of the main window.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>Q</keycap></keycombo></shortcut><guimenuitem>Quit</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Quit the application.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : The 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 five tabs: <guilabel>Network Neighborhood</guilabel>, <guilabel>Mounted Shares</guilabel>, <guilabel>Bookmarks</guilabel>, <guilabel>Profiles</guilabel>, and <guilabel>Configuration</guilabel>.</para>

  <screenshot>
    <screeninfo>Screenshot of the plasmoid on the desktop</screeninfo>
    <mediaobject>
      <imageobject><imagedata fileref="plasmoid.png" format="PNG" /></imageobject>
      <textobject><phrase>Screenshot of the plasmoid</phrase></textobject>
    </mediaobject>
  </screenshot>

<!-- 
      Using Smb4K : The Plasmoid : Network Neighborhood Tab 
  -->

  <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>

    <screenshot>
      <screeninfo>Screenshot of the plasmoid's network neighborhood tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="plasmoid_network_neighborhood_tab.png" format="PNG" /></imageobject>
        <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>By clicking an entry you either enter the level below (&eg; clicking a workgroup or domain item will show a list of all hosts belonging to it), mount the selected share, or invoke the print dialog. To go one level up, you need to click the <guibutton>Up</guibutton> button in the tool bar.</para>
    <para>For hosts and shares, there are some action buttons to the right of the network item's name. For hosts, there is one button with which you can open the <link linkend="network_neighborhood_browser_defining_custom_settings">Custom Settings</link> editor. For shares, there are additional buttons for <link linkend="network_neighborhood_browser_previewing">previewing the content of the selected share</link> and for <link linkend="bookmarks_adding">adding the share to the bookmarks</link>. The action buttons are transparent by default and change to opaque when you move the mouse over them. By left clicking, you initiate the chosen action.</para>
    <para>Besides the <guibutton>Up</guibutton> button, the tool bar contains three more entries: <guibutton>Rescan</guibutton>, <guibutton>Abort</guibutton> and <guibutton>Mount Dialog</guibutton>. With these you can do a rescan, abort any running action, or open the <link linkend="network_neighborhood_browser_mounting">mount dialog</link>.</para>
  </sect2>

<!-- 
      Using Smb4K : The Plasmoid : Mounted Shares Tab 
  -->

  <sect2 id="plasmoid_mounted_shares">
    <title>Mounted Shares Tab</title>

    <para>On the <guilabel>Mounted Shares</guilabel> page all mounted shares are listed:</para>

    <screenshot>
      <screeninfo>Screenshot of the plasmoid's mounted shares tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="plasmoid_mounted_shares_tab.png" format="PNG" /></imageobject>
        <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject></mediaobject>
    </screenshot>

    <para>At the right side of each entry, three action buttons are arranged. The first is for <link linkend="bookmarks_adding">adding a bookmark</link>, the second is for <link linkend="shares_view_synchronization">synchronization</link>, and the third is for <link linkend="shares_view_unmounting">unmounting the share</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 selected action.</para>
    <para>The tool bar contains the <guibutton>Unmount All</guibutton> action that lets you unmount all shares at once.</para>
  </sect2>

<!-- 
      Using Smb4K : The Plasmoid : Bookmarks Tab 
  -->

  <sect2 id="plasmoid_bookmarks">
    <title>Bookmarks Tab</title>

    <para>The bookmarks are listed on the <guilabel>Bookmarks</guilabel> page.</para>
    
    <screenshot>
      <screeninfo>Screenshot of the plasmoid's bookmarks tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="plasmoid_bookmarks_tab.png" format="PNG" /></imageobject>
        <textobject><phrase>Bookmarks tab of the plasmoid</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>Bookmarked shares can be mounted by left clicking the respective bookmark. To edit or remove the bookmarks, press the <guibutton>Edit</guibutton> action button in the tool bar to open the <link linkend="bookmarks_editor">Bookmark Editor</link>. To get back to the top level from a category folder, use the <guibutton>Back</guibutton> button.</para>
  </sect2>

<!-- 
      Using Smb4K : The Plasmoid : Profiles Tab 
  -->

  <sect2 id="plasmoid_profiles">
    <title>Profiles Tab</title>
  
    <para>All defined profiles are listed on the <guilabel>Profiles</guilabel> page. The currently active profile is marked with an appended <guilabel>(active)</guilabel> label.</para>
  
    <screenshot>
      <screeninfo>Screenshot of the plasmoid's profiles tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="plasmoid_profiles_tab.png" format="PNG" /></imageobject>
        <textobject><phrase>Profiles tab of the plasmoid</phrase></textobject>
      </mediaobject>
    </screenshot>
  
    <para>You can activate a certain profile by clicking it. All profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_page_profiles">configuration dialog</link>.</para>
  </sect2>
  
<!--
      Using Smb4K : The Plasmoid : Configuration Tab
  -->
  
  <sect2 id="plasmoid_configuration">
    <title>Configuration Tab</title>
    
    <para>To configure the behavior of &smb4k;, you can launch the <link linkend="configuration">configuration dialog</link> on the <guilabel>Configuration</guilabel> page.</para>
    
    <screenshot>
      <screeninfo>Screenshot of the plasmoid's configuration tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="plasmoid_configuration_tab.png" format="PNG" /></imageobject>
        <textobject><phrase>Configuration tab of the plasmoid</phrase></textobject>
      </mediaobject>
    </screenshot>
    
    <caution>
      <para>You should not open two configuration dialogs (through the main application and via the &plasmoid;) at the same time, because they might interfere with each other.</para>
    </caution>
  </sect2>
  
</sect1>

<!-- 
      Using Smb4K : Bookmarks 
  -->

  <sect1 id="bookmarks">
    <title>Bookmarks</title>

<!--
      Using Smb4K : Bookmarks : Adding Bookmarks
  -->
  
    <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>, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>. In the main window, this is done by selecting one or more 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 assign the bookmark to a category. Double-click a bookmark to open the input widget.</para>

      <screenshot>
        <screeninfo>Screenshot of the bookmarks addition dialog</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="bookmarks_add_bookmark_dialog.png" format="PNG" /></imageobject>
          <textobject><phrase>Bookmarks addition dialog</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>Defining categories may help you organize the bookmarks. In the <link linkend="bookmarks_menu">bookmark menu</link>, all bookmarks belonging to the same category are arranged in a respective submenu.</para>
      <para>The label can be any text describing the share. In case you define a label, it will be displayed in the bookmarks menu instead of the location by default. If you want to change this behavior, you can do so in the <link linkend="configuration_page_user_interface_main_window">configuration dialog</link>.</para>
    </sect2>
    
<!--
      Using Smb4K : Bookmarks : Accessing and Managing Bookmarks
  -->

    <sect2 id="bookmarks_menu">
      <title>Accessing and Managing Bookmarks</title>

      <para>In the main window, the bookmarks can be accessed and managed through the <guilabel>Bookmarks</guilabel> menu.</para>

      <screenshot>
        <screeninfo>Screenshot of the bookmark popup menu</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="bookmarks_popup_menu.png" format="PNG" /></imageobject>
          <textobject><phrase>Bookmark popup menu</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>There are two static items in the menu:</para>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Opens the <link linkend="bookmarks_editor">bookmark editor</link>. This entry is disabled if there are no bookmarks.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice>
              <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut>
              <guimenuitem>Add Bookmark</guimenuitem>
            </menuchoice>
          </term>
          <listitem>
            <para>Adds bookmarks to the selected shares. At least one share must be selected to enable this entry.</para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>If there are bookmarks present that are not assigned to a category, and are, thus, shown directly at the top level of the menu, a third item is present:</para>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guimenuitem>Mount Bookmarks</guimenuitem></menuchoice>
          </term>
          <listitem>
            <para>Mount all top level bookmarks at once. This entry is disabled if all bookmarked shares are already mounted.</para>
          </listitem>
        </varlistentry>
      </variablelist>

      <para>The following entries are category submenus and bookmarks that do not belong to any category. The entries are listed alphabetically and the bookmarks may appear either with their location or a descriptive label. If you click a bookmark, the respective share will be mounted. In case a bookmarked share is already mounted, the entry is disabled.</para>
      <para>The category submenus contain the assigned bookmarks as well as a <guimenuitem>Mount Bookmarks</guimenuitem> menu item. It can be used to mount all bookmarks in that category at once.</para>
      <para>In the system tray widget, there is a similar <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> which, however, does not come with the <guilabel>Add Bookmark</guilabel> entry.</para>
      <para>The &plasmoid; provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar manner as in the bookmark menu. For further details read <link linkend="plasmoid_bookmarks">this section</link>.</para>
    </sect2>
    
<!--
      Using Smb4K : Bookmarks : Editing Bookmarks
  -->

    <sect2 id="bookmarks_editor">
      <title>Editing Bookmarks</title>

      <para>The bookmarks may be edited or removed via the bookmark editor or the <guilabel>Bookmarks</guilabel> page in the <link linkend="configuration_page_bookmarks">configuration dialog</link>. The bookmark editor can be opened by clicking the <guimenuitem>Edit Bookmarks</guimenuitem> entry in the <guilabel>Bookmarks</guilabel> menu or the <guimenuitem>Edit</guimenuitem> action in the <guilabel>Bookmarks</guilabel> tab of the &plasmoid;.</para>
      <screenshot>
        <screeninfo>Screenshot of the bookmark editor</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="bookmarks_editor.png" format="PNG" /></imageobject>
          <textobject><phrase>Bookmark editor</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>In the tree view, the bookmarks are arranged according to the categories they belong to. Bookmarks without a category are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so you can move bookmarks around with the mouse.</para>
      <para>If you want to edit a bookmark, you can do so by either double-clicking or selecting it and pressing the <guibutton>Edit</guibutton>button. The input widget will then be shown. Here you can edit the label, category name, login, workgroup or domain name and the IP address.</para>
      <screenshot>
        <screeninfo>Screenshot of the bookmark editor with opened input widget</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="bookmarks_editor_with_input_widget.png" format="PNG" /></imageobject>
          <textobject><phrase>Bookmark editor with opened input widget</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>In most cases, you do not need to touch the IP address and the login, because &smb4k; stores the correct values at the time you bookmark the share. However, if the server got a different IP address (&eg; because DHCP is used on your local network), or your login changed, these entries should be adjusted. You also should adjust the workgroup or domain name, if its name was discovered by DNS-SD (and is most likely called <emphasis>LOCAL</emphasis>). With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the location, but this can be changed in the <link linkend="configuration_page_user_interface_main_window">configuration dialog</link>. Finally,the category entry helps you to organize your bookmarks. For instance, if you use your notebook at home and also at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two categories, "Home" and "Work", and categorize the bookmarks accordingly.</para>
      <para>With the <guibutton>Add Category</guibutton> button, you can add a category. The <guibutton>Remove</guibutton> button removes the selected bookmark and the <guibutton>Clear List</guibutton> button clears the whole list of bookmarks. As long as you have not saved the changes by clicking the <guibutton>Save</guibutton> button, you can reset all your changes with the <guibutton>Reset</guibutton> button.</para>
    </sect2>
  </sect1>
  
<!--
      Using Smb4K : Custom Settings
  -->
  
  <sect1 id="custom_settings">
    <title>Custom Settings</title>

    <sect2 id="custom_settings_usage">
      <title>Using Custom Settings</title>

      <para>Besides the global settings that can be defined in the <link linkend="configuration">configuration dialog</link>, &smb4k; offers the possibility to configure individual settings per server or share. You can make use of these custom settings if you want to</para>
      <itemizedlist>
        <listitem><para>define individual browse or mount settings for a single server or share that deviate from the values defined in the configuration dialog,</para></listitem>
        <listitem><para>define a server that should be awakened prior to network scans or mount attempts (Wake-On-LAN feature, see <link linkend="configuration_page_network_advanced_settings_wake_on_lan">here</link>),</para></listitem>
        <listitem><para>always mount a particular share on start-up or when the corresponding profile is loaded.</para></listitem>
      </itemizedlist>
    </sect2>

    <sect2 id="custom_settings_adding">
      <title>Adding Custom Settings</title>

      <para>To define custom settings, in both, the <link linkend="network_neighborhood_browser_actions_popup_menu">network neighborhood browser</link> and the <link linkend="shares_view_actions_popup_menu">shares view</link>, you can open the editor for the custom settings by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Add Custom Settings</guimenuitem></menuchoice> menu entry.</para>
    
      <screenshot>
        <screeninfo>Screenshot of the custom settings editor for a share</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="custom_settings_editor.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>The custom settings editor</phrase>
          </textobject>
        </mediaobject>
      </screenshot>

      <para>Custom settings that you defined for a server will also be applied to its shares.</para>

      <para>The following settings can be made:</para>
      
      <variablelist>
        <varlistentry>
          <term>
            <guilabel>Basic Settings</guilabel>
          </term>
          <listitem>
            <para>You can set the IP address and the workgroup or domain of the server here. If you selected a share, you can also check the <guibutton>Always remount this share</guibutton> button to remount it every time you start &smb4k; or load the respective <link linkend="profiles">profile</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <guilabel>Common Mount Settings</guilabel> (&Linux; only)
          </term>
          <listitem>
            <para>You can define common settings related to mounting here. For detailed information about these settings have a look at <link linkend="configuration_page_mounting_common_mount_settings">this section</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <guilabel>Advanced Mount Settings</guilabel> (&Linux; only)
          </term>
          <listitem>
            <para>You can define advanced settings related to mounting here. For detailed information about these settings have a look at <link linkend="configuration_page_mounting_advanced_mount_settings">this section</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <guilabel>Mount Settings</guilabel> (BSD only)
          </term>
          <listitem>
            <para>You can define settings related to mounting here. For detailed information about these settings have a look at <link linkend="configuration_page_mounting_mount_settings">this section</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <guilabel>Browse Settings</guilabel>
          </term>
          <listitem>
            <para>You can define the minimal and maximal SMB protocol versions as well as the SMB port to be used. In addition, you can decide if Kerberos should be used for authentication. For detailed information about these settings have a look at <link linkend="configuration_page_network">this section</link>.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <guilabel>Wake-On-LAN Settings</guilabel>
          </term>
          <listitem>
            <para>To make the Wake-On-LAN feature work, you must provide the MAC address of the server you selected. Currently, &smb4k; has no way to determine the MAC address, so you need to find it on your own. Afterwards, you can define if the server should be woken up by sending a magic Wake-On-LAN packet before the network neighborhood is scanned and/or one of its shares is mounted.</para>
            <para>Please note that you need to enable the Wake-On-LAN capabilities in the <link linkend="configuration_page_network_advanced_settings_wake_on_lan">configuration dialog</link> to take advantage of these settings.</para>
          </listitem>
        </varlistentry>
      </variablelist>
      
      <para>With the <guibutton>Defaults</guibutton> button you can reset all settings in the editor to their default values as they are defined in the configuration dialog. Custom settings that only contain default values are removed. Using the <guibutton>Reset</guibutton> button, you can reset the entries in the dialog to their initial values. Clicking the <guibutton>Save</guibutton> button saves the custom settings and closes the dialog.</para>
      <para>Please note that under BSD the dialog contains fewer entries than if you run &Linux;, because several of the options are not supported.</para>
    </sect2>

    <sect2 id="custom_settings_managing_and_editing">
      <title>Editing Custom Settings</title>

      <para>You can edit or reset the settings of individual network items by opening the custom settings editor. A complete overview of all custom settings provides the <link linkend="configuration_page_custom_settings"><guilabel>Custom Settings</guilabel> configuration page</link>, where you also can edit or remove the desired settings.</para>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : Profiles 
  -->

  <sect1 id="profiles">
    <title>Profiles</title>
    
    <para>&smb4k; offers the option to use different profiles. They are intended to facilitate handling of different network neighborhoods, &eg;, if you are using your laptop at home and also at work.</para>
    <para>By default, the use of profiles is disabled. Most users won't have to change this, because the default behavior satisfies their needs completely. However, for some users this feature might be useful.</para>
  
<!-- 
      Using Smb4K : Profiles : Enabling and Managing Profiles 
  -->
  
    <sect2 id="profiles_enable">
      <title>Enabling and Managing Profiles</title>
      <para>The use of different profiles can be enabled in the <link linkend="configuration_page_profiles">configuration dialog</link> by ticking the <guibutton>Use profiles</guibutton> checkbox. The initial active profile is then set and indicated by the tick mark next to it in the list view. The name of the active profile is also shown in parentheses in the title of the <guilabel>Authentication</guilabel>, <guilabel>Bookmarks</guilabel> and <guilabel>Custom Settings</guilabel> configuration pages.</para>
      <screenshot>
        <screeninfo>Screenshot of the title section of the Authentication configuration page with indicated profile</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="configuration_page_authentication_profile_indicator.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>Screenshot of the title section of the Authentication configuration page with indicated profile</phrase>
          </textobject>
        </mediaobject>
      </screenshot>

      <para>There are two pre-defined profiles, <guilabel>Home</guilabel> and <guilabel>Work</guilabel>, but you can have as many profiles as you want. A new profile is added by entering its name into the input line and then clicking the <guibutton>Add</guibutton> button.</para>
      <screenshot>
        <screeninfo>Screenshot of the Profiles configuration page (add profile)</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="configuration_page_profiles_add_profile.png" format="PNG" />
          </imageobject>
          <textobject>
            <phrase>Profiles configuration page (add profile)</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
      <para>To set the active profile, either double click the profile name or mark the profile name and click the <guibutton>Set Active</guibutton> button. To rename a profile, select it, click <guibutton>Rename</guibutton> and edit the name in the list view. All custom settings, bookmarks and default login credentials will be migrated seamlessly to the new name. To remove a profile, select it and click <guibutton>Remove</guibutton>. You may also change the order of the profiles with the <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons.</para>
    </sect2>
  
<!-- 
      Using Smb4K : Profiles : Activating a Profile 
  -->
  
    <sect2 id="profiles_activate_profile">
      <title>Activating a Profile</title>

      <para>The active profile can either be changed in the configuration dialog as mentioned <link linkend="profiles_enable">above</link>, or in the <guimenu>Profiles</guimenu> menu of the main window or system tray widget, or on the <guilabel>Profiles</guilabel> page of the plasmoid.</para>
      <para>When a profile is activated, these things happen:</para>
      <itemizedlist>
        <listitem><para>All currently mounted shares are unmounted and scheduled for remount.</para></listitem>
        <listitem><para>All shares that were previously mounted under the newly activated profile are remounted.</para></listitem>
        <listitem><para>The default login credentials (if defined), bookmarks and custom settings from the new profile are loaded.</para></listitem>
      </itemizedlist>
      <para>So, don't be surprised when things change after you select a different profile ...</para>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : Notifications 
  -->

  <sect1 id="notifications">
    <title>Notifications</title>
  
<!-- 
      Using Smb4K : Notifications : Default Behavior
  -->
  
    <sect2 id="notifications_default_behavior">
      <title>Default Behavior</title>
      <para>Normal events like mounting and unmounting of a share as well as warnings and errors are reported to the user via system notifications. By default, when the user is notified about a normal event, a notification pops up silently. With warnings and errors a sound is also played. The screenshot below shows the notification that pops up after a share has been mounted.</para>
      <screenshot>
        <screeninfo>Screenshot of the notification after mounting a share</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="notification_share_mounted.png" format="PNG" /></imageobject>
          <textobject><phrase>Notification after mounting a share</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>The default behavior of each notification can be changed via the <link linkend="notifications_manage">&systemsettings;</link>.</para>
    </sect2>

<!-- 
      Using Smb4K : Notifications : Managing Notifications 
  -->

    <sect2 id="notifications_manage">
      <title>Managing Notifications</title>
      <para>Notifications can be managed via the &systemsettings;. To modify the behavior of a notification, navigate to the <guibutton>Notifications</guibutton> page. In the section <guilabel>Application-specific settings</guilabel> click the <guibutton>Configure</guibutton> button and choose &smb4k; from the list that appears. The following dialog is opened:</para>
      <screenshot>
        <screeninfo>Screenshot of the systemsettings notification module</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="systemsettings_manage_notifications.png" format="PNG" /></imageobject>
          <textobject><phrase>Systemsettings notification module</phrase></textobject>
        </mediaobject>
      </screenshot>
      <para>All notifications can be edited here according to your preferences.</para>
    </sect2>
  </sect1>

<!-- 
      Using Smb4K : Trouble Shooting
-->

  <sect1 id="trouble_shooting">
    <title>Trouble Shooting</title>

<!--
    Using Smb4K : Trouble Shooting : Missing Programs
    -->

    <sect2 id="trouble_shooting_missing_programs">
      <title>Missing Programs</title>

      <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">
        <screeninfo>Screenshot of the missing program notification</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="notification_missing_program.png" format="PNG" /></imageobject>
          <textobject><phrase>The missing program notification</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>In this case, please install the specified program or, if it is already present, add its location to the <envar>PATH</envar> environment variable in your shell's configuration file (for the <ulink url="man:/bash"><citerefentry><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> shell it is the <filename>~/.bashrc</filename> file).</para>
    </sect2>

<!--
    Using Smb4K : Trouble Shooting : Zeroconf Daemon
    -->

    <sect2 id="trouble_shooting_zeroconf">
      <title>Zeroconf Error</title>

      <para>&smb4k; uses the Zeroconf service (<application><ulink url="https://avahi.org">Avahi</ulink></application>) to look up servers and shares in the network neighborhood using DNS Service Discovery (DNS-SD). For this to work, the Avahi daemon must be enabled and running on your system. If this is not the case, &smb4k; shows an error message:</para>

      <screenshot id="notification_zeroconf_error">
        <screeninfo>Screenshot of the Zeroconf error notification</screeninfo>
        <mediaobject>
          <imageobject><imagedata fileref="notification_zeroconf_error.png" format="PNG" /></imageobject>
          <textobject><phrase>The Zeroconf error notification</phrase></textobject>
        </mediaobject>
      </screenshot>

      <para>In most cases, the Avahi daemon is not running when an error is reported. Under those &Linux; distributions that use <application>systemd</application> you can start it by running the following or a similar command from the terminal:</para>
      <para><screen><userinput><prompt>$</prompt> <command>sudo</command> <command>systemctl</command> enable --now avahi-daemon</userinput></screen></para>
      <para>With all other &Linux; distributions and under BSD refer to the specific documentation how to start the Avahi daemon.</para>
    </sect2>
  
<!--
    Using Smb4K : Trouble Shooting : Denied Privilege Escalation
-->
    
    <sect2 id="trouble_shooting_polkit-1">
      <title>Denied Privilege Escalation</title>
      
      <para>In case the mount and unmount actions fail (most likely with an <guilabel>AuthorizationDeniedError</guilabel> message), your polkit-1 setup might need to be adjusted: Add a file, &eg; named <filename>10-mounthelper.rules</filename>, to the <filename class="directory">$PREFIX/etc/polkit-1/rules.d/</filename> directory with the following content:</para>

<programlisting>polkit.addRule(function(action, subject) {
        if (action.id == "org.kde.smb4k.mounthelper.mount" &amp;&amp; 
            subject.isInGroup("wheel")) {
                return polkit.Result.YES;
        }
});

polkit.addRule(function(action, subject) {
        if (action.id == "org.kde.smb4k.mounthelper.unmount" &amp;&amp;
            subject.isInGroup("wheel")) {
                return polkit.Result.YES;
        }
});</programlisting>
      
      <para>This allows all users in the Unix group <emphasis>wheel</emphasis> to execute the mount and unmount actions. You may adjust the group of authorized users to any group you prefer to use (&eg; <emphasis>sudo</emphasis> or <emphasis>operator</emphasis>).</para>
    </sect2>
  
<!--
      Using Smb4K : Trouble Shooting : Mounting Problems under BSD
  -->
    
    <sect2 id="trouble_shooting_mounting_problems_under_bsd">
      <title>Mounting Problems Under BSD</title>
      
      <para>If mounting of shares from either a &Samba; or a &Windows; server fails, this might be because <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> only uses NTLMv1 authentication and requires the SMB 1.0/&CIFS; protocol, and the server does not support those. To fix mounting for a &Samba; server, you can add the following entries to the [global] section of the <ulink url="man:/smb.conf"><citerefentry><refentrytitle><filename>smb.conf</filename></refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> file of <emphasis>the server</emphasis>:</para>
      
<programlisting>[global]
...
ntlm auth = yes
server min protocol = NT1
...
</programlisting>
      
      <para>If you want to fix this issue for a &Windows; server, please contact the sysadmin and tell her or him that NTLMv1 authentication and the SMB 1.0/&CIFS; protocol should be switched on (if possible).</para>

      <note><para>It is not advisable to enable the SMB 1.0/&CIFS; protocol on a server, because it is considered insecure (see &eg; <ulink url="https://techcommunity.microsoft.com/t5/storage-at-microsoft/stop-using-smb1/ba-p/425858">here</ulink>) and was thus disabled in newer &Samba; and &Windows; versions (see &eg; <ulink url="https://learn.microsoft.com/en-us/archive/blogs/josebda/the-deprecation-of-smb1-you-should-be-planning-to-get-rid-of-this-old-smb-dialect">here</ulink> and <ulink url="https://www.samba.org/samba/history/samba-4.11.0.html">here</ulink>).</para></note>
    </sect2>
    
<!-- 
      Using Smb4K : Trouble Shooting : Other Desktops Than Plasma
-->

    <sect2 id="trouble_shooting_other_desktop_environments">
      <title>Other Desktop Environments Than &plasma;</title>

      <para>When using a different desktop environment than &plasma;, &Qt; and &kde-frameworks; applications might be missing some icons. In that case, you might want to install the <application>qt6ct</application> (<ulink url="https://github.com/trialuser02/qt6ct">download</ulink>) application. To use it with your desktop environment, add the following to your <filename>~/.xinitrc</filename> or <filename>~/.profile</filename> file:</para>
      <para><emphasis>X11:</emphasis></para>
<programlisting>
export QT_QPA_PLATFORMTHEME=qt6ct</programlisting>
      <para><emphasis>Wayland:</emphasis></para>
<programlisting>
export QT_QPA_PLATFORM=wayland
export QT_QPA_PLATFORMTHEME=qt6ct
</programlisting>
    </sect2>
  </sect1>
</chapter>


<!-- 
      Configuring Smb4K 
-->

<chapter id="configuration">
  <title>Configuring &smb4k;</title>

  <para>This section describes the settings that can be used to configure &smb4k;. To open the configuration dialog, you must click the <link linkend="mainwindow_overview"><guimenuitem>Configure &smb4k;...</guimenuitem></link> menu item.</para>

<!-- 
      Configuring Smb4K : User Interface 
  -->

  <sect1 id="configuration_page_user_interface">
    <title>User Interface</title>

    <para>You can change the appearance and behavior of several dialogs and widgets with the options located here. Please note that if you want to change the appearance of the main window, additional options are available under <guimenu>Settings</guimenu> in the <link linkend="mainwindow_overview">menu bar</link>.</para>
    <screenshot>
      <screeninfo>Screenshot of the "User Interface" configuration tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_user_interface.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Appearance" configuration tab</phrase></textobject>
      </mediaobject>
    </screenshot>
    
<!--
      Configuring Smb4K : User Interface : Main Window
  -->
    <sect2 id="configuration_page_user_interface_main_window">
      <title>Main Window</title>
      
      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Tab orientation</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Define the location of the tabs if the dock widgets in the main window are arranged as tabs. The following values can be chosen:</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Top</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The tabs are located at the top.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Bottom</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The tabs are located at the bottom.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Left</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The tabs are located on the left side.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Right</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The tabs are located on the right side.</para>
                </listitem>
              </varlistentry>
            </variablelist>
            <para>Default: <guimenuitem>Bottom</guimenuitem></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show custom bookmark label if available</guibutton></menuchoice>
          </term>
          <listitem>
            <para>The custom description (label) of the bookmark is shown. It can be defined in the <link linkend="bookmarks_editor">bookmark editor</link>.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>

<!-- 
      Configuring Smb4K : User Interface : Network Neighborhood 
  -->

    <sect2 id="configuration_page_user_interface_network">
      <title>Network Neighborhood</title>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Icon size</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Set the icon size in the network neighborhood browser. The size can be adjusted in steps of 16 pixels from 16 x 16 pixels to 128 x 128 pixels.</para>
            <para>Default: small icon size</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Automatically expand domains and hosts</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Automatically expand domain and host items when a list of associated network items (domain members or shares) is added or updated. Please note that a domain or host item will always be expanded when you execute it.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show the type of the share</guibutton></menuchoice>
          </term>
          <listitem>
            <para>The type of the shares is shown (i. e. Disk, Printer, or IPC).</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show the IP address of the server</guibutton></menuchoice>
          </term>
          <listitem>
            <para>The IP address of the remote servers is shown.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show the comment</guibutton></menuchoice>
          </term>
          <listitem>
            <para>The comment of a remote server or share is shown.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show tooltips for network items</guibutton></menuchoice>
          </term>
          <listitem>
            <para>A tooltip will be shown when you move the mouse pointer over an item in the network neighborhood browser. It contains information about the network item such as the workgroup or domain name, host name, comment, type, &etc;</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>

<!-- 
      Configuring Smb4K : User Interface : Shares View 
  -->

    <sect2 id="configuration_page_user_interface_shares_view">
      <title>Shares View</title>
  
      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>View mode</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Define the view mode of the shares view.</para>
            <para>The following modes are defined:</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>Icon View</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The icon view mode</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guimenuitem>List View</guimenuitem></menuchoice>
                </term>
                <listitem>
                  <para>The list view mode</para>
                </listitem>
              </varlistentry>
            </variablelist>
            <para>Default: <guimenuitem>Icon View</guimenuitem></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Icon size for the icon view</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Set the icon size in the icon view of the shares view. The size can be adjusted in steps of 16 pixels from 16 x 16 pixels to 128 x 128 pixels.</para>
            <para>Default: desktop icon size</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Icon size for the list view</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Set the icon size in the list view of the shares view. The size can be adjusted in steps of 16 pixels from 16 x 16 pixels to 128 x 128 pixels.</para>
            <para>Default: small icon size</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Show tooltips for mounted shares</guibutton></menuchoice>
          </term>
          <listitem>
            <para>A tooltip will be shown when you move the mouse pointer over an item in the shares view. It contains information about the mounted share such as the share name, UNC address, mount point, owner and group, login (&CIFS; file system, &Linux; only), disk usage, &etc;</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>
  </sect1>

<!-- 
      Configuring Smb4K : Network 
-->

  <sect1 id="configuration_page_network">
    <title>Network</title>

    <para>The settings located here influence the network communication. You can modify the browse settings and behavior in the <guibutton>Basic Settings</guibutton> tab and the more advanced options for Samba and the Wake-On-LAN capabilities in the <guibutton>Advanced Settings</guibutton> tab.</para>
    
    <screenshot>
      <screeninfo>Screenshot of the "Network" configuration tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_network.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Network" configuration tab</phrase></textobject>
      </mediaobject>
    </screenshot>
    
<!--
      Configuring Smb4K : Network : Basic Settings
    -->
    
    <sect2 id="configuration_page_network_basic_settings">
      <title>Basic Settings</title>
      
      <sect3 id="configuration_page_network_basic_settings_browse_settings">
        <title>Browse Settings</title>
        
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use Web Services Dynamic Discovery (WS-Discovery) for browsing</guibutton></menuchoice>
            </term>
            <listitem>
              <para>The Web Services Dynamic Discovery (WS-Discovery) protocol is used to browse the local network and discover workgroups, domains and hosts. This is useful if your network neighborhood is dominated by servers with modern &Windows; versions.</para>
              <note><para>This setting is optional, and only appears if you compiled &smb4k; with WS-Discovery support.</para></note>
              <para>Default: selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use DNS Service Discovery (DNS-SD) for browsing</guibutton></menuchoice>
            </term>
            <listitem>
              <para>The DNS Service Discovery (DNS-SD) interface is used to browse the local network and discover servers that provide shared SMB resources. The discovered domains correspond to the local DNS domains (&eg; named LOCAL) and most likely not the ones defined in the network neighborhood. However, this does not influence the browsing.</para>
              <para>Default: selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set minimal and maximal SMB protocol version</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Set the minimal and maximal SMB protocol version that is used by &Samba;'s client library to browse the network neighborhood. This will override the settings in the smb.conf file. Normally, you do not need to use this option, because the right protocol versions should be negotiated between the client and the server while establishing a connection. Please note that this setting might not be appropriate to make the discovery of workgroups and domains work while keeping undisturbed connectivity to servers. Use DNS Service Discovery (DNS-SD) or Web Services Dynamic Discovery (WS-Discovery) for domain and workgroup lookups instead.</para>
              <para>The settings below for the minimal and maximal SMB protocol version are enabled by checking this checkbox.</para>
              <para>The maximal SMB protocol version must be equal to or greater than the minimal SMB protocol version.</para>
              <para>Default: not selected</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guilabel>Minimal SMB protocol version:</guilabel></menuchoice>
                  </term>
                  <listitem>
                    <para>The following protocol versions can be set:</para>
                    <variablelist>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>NT1 (Classic CIFS/SMBv1 protocol)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the classic version of the protocol. It is used by &Windows; NT and is known as CIFS or SMBv1. It is considered to be unsafe and was disabled in the latest &Samba; and &Windows; versions.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>SMB2 (Windows Vista and above)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the re-implementation of the SMB protocol. It is used by &Windows; Vista and above.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>SMB3 (Windows 8 and above)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the SMBv3 protocol version. It features several improvements of the functionality and performance of SMBv2 as well as several security enhancements. This protocol version is used by &Windows; 8 and above.</para>
                        </listitem>
                      </varlistentry>
                    </variablelist>
                    <para>Default: <guimenuitem>SMB2 (Windows Vista and above)</guimenuitem></para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guilabel>Maximal SMB protocol version:</guilabel></menuchoice>
                  </term>
                  <listitem>
                    <para>The following protocol versions can be set:</para>
                    <variablelist>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>NT1 (Classic CIFS/SMBv1 protocol)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the classic version of the protocol. It is used by &Windows; NT and is known as CIFS or SMBv1. It is considered to be unsafe and was disabled in the latest &Samba; and &Windows; versions.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>SMB2 (Windows Vista and above)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the re-implementation of the SMB protocol. It is used by &Windows; Vista and above.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>SMB3 (Windows 8 and above)</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>This is the SMBv3 protocol version. It features serveral improvements of the functionality and performance of SMBv2 as well as serveral security enhancements. This protocol version is used by &Windows; 8 and above.</para>
                        </listitem>
                      </varlistentry>
                    </variablelist>
                    <para>Default: <guimenuitem>SMB3 (Windows 8 and above)</guimenuitem></para>
                  </listitem>
                </varlistentry>
              </variablelist>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
        
      <sect3 id="configuration_page_network_basic_settings_behavior">
        <title>Behavior</title>
    
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Detect printer shares</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Printer shares are detected.</para>
              <para>Default: selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Detect hidden shares</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Hidden shares are detected. Hidden shares are ending with a $ sign, &eg; Musik$ or IPC$.</para>
              <para>Default: selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preview hidden files and directories</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Show all files and directories including the hidden ones when opening a share's contents in the preview dialog.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>

<!-- 
      Configuring Smb4K : Network : Advanced Settings
-->

    <sect2 id="configuration_page_network_advanced_settings">
      <title>Advanced Settings</title>
      
      <sect3 id="configuration_page_network_advanced_settings_samba">
        <title>Samba</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set the SMB port to</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Enabling this setting sets the remote SMB port number to communicate with a remote host to the value defined in the spin box. Under BSD, this is also the port that is used for mounting.</para>
              <para>Unless you are using a firewall or have a customized network setup, you do not need to change anything here.</para>
              <para>Default: 139</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set the encryption level to</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Set the level of encryption that is used to make connections. The following settings can be chosen:</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>None</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Encryption is not used.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>Request</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Encryption is requested.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>Require</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Encryption is required.</para>
                  </listitem>
                </varlistentry>                
              </variablelist>
              <para>Default: <guimenuitem>None</guimenuitem></para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>This computer is on a large network neighborhood</guibutton></menuchoice>
            </term>
            <listitem>
              <para>In the default configuration, all available master browsers are queried when the browse list is compiled. On large network neighborhoods this can be very time consuming. Enabling this setting restricts the query to three master browsers.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Master browsers require authentication</guibutton></menuchoice>
            </term>
            <listitem>
              <para>If the workgroup master browsers require authentication to return the browse list, you need to check this button. This may be the case for example with some NAS devices. This setting is rarely needed and might even cause a master browser to return an empty browse list.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use Kerberos for authentication</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Use Kerberos for authentication in an Active Directory environment.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use Winbind ccache for authentication</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Try to use the credentials cached by Winbind.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>          
        </variablelist>
      </sect3>
      <sect3 id="configuration_page_network_advanced_settings_wake_on_lan">
        <title>Wake-On-LAN</title>

        <para>To be able to use the Wake-On-LAN capability of &smb4k;, you have to enable this setting. The hosts that should to be woken up have to be defined through the <link linkend="network_neighborhood_browser_defining_custom_settings">custom settings editor</link>.</para>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Enable Wake-On-LAN features</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Enable Wake-on-LAN (WOL) features. Wake-On-LAN is an ethernet computer networking standard that allows a computer to be turned on or woken up by a network message. Smb4K uses a magic packet send via a UDP socket to wake up remote servers. If you want to take advantage of the Wake-On-LAN feature, you need to enable this option.</para>
              <para>Default: not selected</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guilabel>Waiting time</guilabel></menuchoice>
                  </term>
                  <listitem>
                    <para>This is the waiting time in seconds between the sending of the magic Wake-On-LAN packets and the scanning of the network neighborhood or the mounting of a share.</para>
                    <para>Default: 5 s</para>
                  </listitem>
                </varlistentry>
              </variablelist>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>
  </sect1>

<!-- 
      Configuring Smb4K : Mounting 
-->

  <sect1 id="configuration_page_mounting">
    <title>Mounting</title>
    
    <para>This configuration page contains all settings regarding the mounting of shares. The settings appearing here are depending on the operation system you are using.</para>
      
    <screenshot>
      <screeninfo>Screenshot of the "Mounting" configuration page</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_mounting.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Mounting" configuration page</phrase></textobject>
      </mediaobject>
    </screenshot>
    
<!--
      Configuring Smb4K : Mounting : Basic Settings
-->
    
    <sect2 id="configuration_page_mounting_basic_settings">
      <title>Basic Settings</title>
      
      <para>The settings in this tab are the same for all supported operating systems.</para>
      
      <sect3 id="configuration_page_mounting_basic_settings_directories">
        <title>Directories</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Mount prefix</guibutton></menuchoice>
            </term>
            <listitem>
              <para>This is the base folder (mount prefix) where &smb4k; will mount the remote shares. It can be changed by using the &URL; requester (Click the button with the folder icon.) or by directly entering the new path into the text box. Path variables like <envar>$HOME</envar> are recognized.</para>
              <para>Default: <filename class="directory">$HOME/smb4k/</filename></para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Force generated subdirectories to be lower case</guibutton></menuchoice>
            </term>
            <listitem>
              <para>All subdirectories that are created by &smb4k; below the mount prefix will be lower case.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_mounting_basic_settings_behavior">
        <title>Behavior</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Remount shares</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Remount all your shares that were mounted when you exited the program or changed a profile. If the remounting of a share fails, Smb4K will retry the next time it is started. Shares that were mounted by other users are ignored.</para>
              <para>Default: not selected</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guilabel>Number of remount attempts</guilabel></menuchoice>
                  </term>
                  <listitem>
                    <para>Set the number of attempts that are made to remount shares before Smb4K gives up.</para>
                    <para>Default: 1</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guilabel>Interval between remount attempts</guilabel></menuchoice>
                  </term>
                  <listitem>
                    <para>Set the time that elapses between attempts to remount shares.</para>
                    <para>Default: 5 min</para>
                  </listitem>
                </varlistentry>  
              </variablelist>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Unmount all personal shares on exit</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Unmount all shares that belong to you when the program exits. Shares that are owned by other users are ignored.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Force unmounting of inaccessible shares</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Force unmounting of inaccessible shares (&Linux; only). In case a share is inaccessible, a lazy unmount is performed. Before the actual unmounting is done, a warning dialog is shown asking to approve the unmount.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Allow the unmounting of shares that are owned by other users</guibutton></menuchoice>
            </term>
            <listitem>
              <para>This option will allow you to unmount shares that were mounted by other users.</para>
              <para>USE WITH EXTREME CAUTION!</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Detect all shares that are mounted on the system</guibutton></menuchoice>
            </term>
            <listitem>
              <para>You will not only see the shares that were mounted and are owned by you, but also all other mounts using the SMBFS (BSD) and &CIFS; (&Linux;) file system that are present on the system.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>  
        </variablelist>
      </sect3>
    </sect2>
  
<!--
      Configuring Smb4K : Mounting : Common Mount Settings (Linux)
-->
  
    <sect2 id="configuration_page_mounting_common_mount_settings">
      <title>Common Mount Settings (&Linux; only)</title>
      
      <para>The <guilabel>Common Mount Settings</guilabel> tab is only available under &Linux; and the listed options refer to the <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> / <ulink url="man:/mount.smb3"><citerefentry><refentrytitle>mount.smb3</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> command. The settings present under BSD can be found in the <link linkend="configuration_page_mounting_mount_settings">Mount Settings (BSD only)</link> section.</para>

      <sect3 id="configuration_page_mounting_common_mount_settings_common_options">
        <title>Common Options</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Write access</guibutton></menuchoice>
            </term>
            <listitem>
              <para>The write access to a share can be determined here. This option is independent of the file mask and the folder mask settings above. Available options are:</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>read-write</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Option: <option>rw</option></para>
                    <para>Mount the share read-write.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>read-only</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Option: <option>ro</option></para>
                    <para>Mount the share read-only.</para>
                  </listitem>
                </varlistentry>
              </variablelist>
              <para>Default: not selected; <guimenuitem>read-write</guimenuitem></para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Client character set</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>iocharset=CHARSET</option></para>
              <para>Sets the character set used by the client side (&ie; your computer) to one of the following:</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>default</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Default character set used by the client's kernel. In this case the <option>iocharset</option> option is omitted from the command line.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-1</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-1:1998. This character-encoding scheme is used throughout the Americas, Western Europe, Oceania, and much of Africa.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-2</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-2:1999.  It is informally referred to as "Latin-2". It is generally intended for Central or "Eastern European" languages that are written in the Latin script.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-3</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-3:1999. It is informally referred to as Latin-3 or South European. It was designed to cover Turkish, Maltese and Esperanto, though the introduction of ISO/IEC 8859-9 superseded it for Turkish.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-4</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-4:1998. It is informally referred to as Latin-4 or North European. It was designed to cover Estonian, Latvian, Lithuanian, Greenlandic, and Sami. It has been largely superseded by ISO/IEC 8859-10 and Unicode.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-5</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-5:1999. It is informally referred to as Latin/Cyrillic. It was designed to cover languages using a Cyrillic alphabet such as Bulgarian, Belarusian, Russian, Serbian and Macedonian but was never widely used.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-6</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-6:1999. It is informally referred to as Latin/Arabic. It was designed to cover Arabic.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-7</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-7:2003. It is informally referred to as Latin/Greek. It was designed to cover the modern Greek language.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-8</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-8:1999. It is informally referred to as Latin/Hebrew. ISO/IEC 8859-8 covers all the Hebrew letters, but no Hebrew vowel signs.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-9</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-9:1999. It is informally referred to as Latin-5 or Turkish. It was designed to cover the Turkish language, designed as being of more use than the ISO/IEC 8859-3 encoding.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-13</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-13:1998. It is informally referred to as Latin-7 or Baltic Rim. It was designed to cover the Baltic languages, and added characters used in the Polish language missing from the earlier encodings ISO 8859-4 and ISO 8859-10. Unlike these two, it does not cover the Nordic languages.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-14</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-14:1998. It is informally referred to as Latin-8 or Celtic. It was designed to cover the Celtic languages, such as Irish, Manx, Scottish Gaelic, Welsh, Cornish, and Breton.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>iso8859-15</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>ISO/IEC 8859-15:1999. It is informally referred to as Latin-9 (and for a while Latin-0). It is similar to ISO 8859-1, and thus also intended for “Western European” languages, but replaces some less common symbols with the euro sign and some letters that were deemed necessary.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>utf8</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Unicode (or Universal Coded Character Set) Transformation Format – 8-bit. UTF-8 is used by many &Linux; distributions as default character set, and is, in addition, by far the most common encoding for the World Wide Web.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>koi8-r</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>KOI8-R (RFC 1489) is an 8-bit character encoding, derived from the KOI-8 encoding by the programmer Andrei Chernov in 1993 and designed to cover Russian, which uses a Cyrillic alphabet.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>koi8-u</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>KOI8-U (RFC 2319) is an 8-bit character encoding, designed to cover Ukrainian, which uses a Cyrillic alphabet.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>koi8-ru</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>KOI8-RU is an 8-bit character encoding, designed to cover Russian, Ukrainian, and Belarusian which use a Cyrillic alphabet.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>cp1251</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Windows-1251 is an 8-bit character encoding, designed to cover languages that use the Cyrillic script such as Russian, Bulgarian, Serbian Cyrillic and other languages. In Linux, the encoding is known as cp1251.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>gb2312</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>GB/T 2312-1980 is a key official character set of the People's Republic of China, used for Simplified Chinese characters. GB2312 is the registered internet name for EUC-CN, which is its usual encoded form. GB/T 2312-1980 has been superseded by GBK and GB18030, which include additional characters, but GB/T 2312 remains in widespread use as a subset of those encodings. </para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>big5</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Big-5 or Big5 is a Chinese character encoding method used in Taiwan, Hong Kong, and Macau for traditional Chinese characters. The People's Republic of China (PRC), which uses simplified Chinese characters, uses the GB 18030 character set instead.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>euc-jp</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>EUC-JP is a variable-width encoding used to represent the elements of three Japanese character set standards, namely JIS X 0208, JIS X 0212, and JIS X 0201.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>euc-kr</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>EUC-KR is a variable-width encoding to represent Korean text using two coded character sets, KS X 1001 (formerly KS C 5601) and either ISO 646:KR (KS X 1003, formerly KS C 5636) or US-ASCII, depending on variant. KS X 2901 (formerly KS C 5861) stipulates the encoding and RFC 1557 dubbed it as EUC-KR.</para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guimenuitem>tis-620</guimenuitem></menuchoice>
                  </term>
                  <listitem>
                    <para>Thai Industrial Standard 620-2533, commonly referred to as TIS-620, is the most common character set and character encoding for the Thai language.</para>
                  </listitem>
                </varlistentry>
              </variablelist>
              <para>Default: not selected; CHARSET: <guimenuitem>default</guimenuitem></para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>File system port</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>port=PORT</option></para>
              <para>Sets the port number that is used by <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> when mounting a remote share. The default port number (445) should work for all modern operating systems. If you experience problems, try setting the port number to 139. If the problems only occur with a few hosts, it is recommended to leave this option untouched and to use the <link linkend="custom_settings">Custom Settings</link> editor to define individual port numbers for the problematic hosts.</para>
              <para>Default: not selected; PORT: 445</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_mounting_cifs_unix_extensions">
        <title>&CIFS; Unix Extensions Support</title>
        <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>All or most of the servers support the &CIFS; Unix extensions</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: none</para>
            <para>Most versions of &Samba; support the &CIFS; Unix or POSIX extensions. For these servers, some options are not needed, because the right values are negotiated during the mount process. For other servers, you might want to uncheck this option, so that predefined values can be passed to the server. Please note that if your computer is located in a &Windows; dominated network neighborhood with only a few &Samba; servers, you can safely uncheck this option and define custom settings for the &Samba; servers.</para>
            <para>In case you uncheck this option, consider to switch on permission checks under <link linkend="configuration_page_mounting_advanced_mount_settings">Advanced Mount Settings</link>.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>User ID</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>uid=UID</option></para>
            <para>Sets the owner of the files and directories on the file system. By default, your UID is used. To change the UID, press the search button and choose one from the drop down menu.</para>
            <para>In case the support for the &CIFS; Unix extensions is selected, this setting is disabled.</para>
            <para>Default: selected; UID: your UID</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Group ID</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>uid=GID</option></para>
            <para>Sets the group that owns the files and directories on the file system. By default, your GID is used. To change the GID, press the search button and choose one from the drop down menu.</para>
            <para>In case the support for the &CIFS; Unix extensions is selected, this setting is disabled.</para>
            <para>Default: selected; GID: your GID</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
              <menuchoice><guibutton>File mode</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>file_mode=ARG</option></para>
            <para>Sets the permissions that are applied to files. The value is given in octal and has to have 4 digits. To learn more about the file mode (file_mode), you should read the <ulink url="man:/mount(8)"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask(2)"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
            <para>In case the support for the &CIFS; Unix extensions is selected, this setting is disabled.</para>
            <para>Default: selected; ARG: 0755</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Directory mode</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>dir_mode=ARG</option></para>
            <para>Sets the permissions that are applied to directories. The value is given in octal and has to have 4 digits. To learn more about the directory mode (dir_mode), you should read the <ulink url="man:/mount(8)"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask(2)"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
            <para>In case the support for the &CIFS; Unix extensions is selected, this setting is disabled.</para>
            <para>Default: selected; ARG: 0755</para>
          </listitem>
        </varlistentry>
      </variablelist>
      </sect3>
    </sect2>
    
<!--
      Configuring Smb4K : Mounting : Advanced Mount Settings (Linux)
-->

    <sect2 id="configuration_page_mounting_advanced_mount_settings">
      <title>Advanced Mount Settings (&Linux; only)</title>
      
      <para>The <guilabel>Advanced Mount Settings</guilabel> tab is only available under &Linux; and the listed options refer to the <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> / <ulink url="man:/mount.smb3"><citerefentry><refentrytitle>mount.smb3</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> command. The settings present under BSD can be found in the <link linkend="configuration_page_mounting_mount_settings">Mount Settings (BSD only)</link> section.</para>
      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Definitely assign the UID</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>forceuid</option></para>
            <para>Instruct the client (i.e. your side) to ignore any user ID (UID) provided by the server for files and directories and to always assign the owner to be the value of the transmitted UID.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Definitely assign the GID</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>forcegid</option></para>
            <para>Instruct the client (i.e. your side) to ignore any group ID (GID) provided by the server for files and directories and to always assign the owner to be the value of the transmitted GID.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Do permission checks</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>perm</option> or <option>noperm</option></para>
            <para>The client side checks if you have the correct UID and GID to manipulate files and directories on the share. This is in addition to the normal ACL check on the target machine done by the server software. You most definitely want to switch this feature off, if the server(s) support the &CIFS; Unix extensions and you are, hence, not allowed to fully access the share.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Attempt to set UID and GID</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>setuids</option> or <option>nosetuids</option></para>
            <para>If the &CIFS; Unix extensions are negotiated with the server the client side will attempt to set the effective UID and GID of the local process on newly created files, directories, and devices. If this feature is turned off, the default UID and GID defined for the share will be used. It is recommended that you read the manual page of <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> before you change this setting.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Use server inode numbers</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>serverino</option> or <option>noserverino</option></para>
            <para>Use inode numbers (unique persistent file identifiers) returned by the server instead of automatically generating temporary inode numbers on the client side. This parameter has no effect if the server does not support returning inode numbers or similar. It is recommended that you read the manual page of <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> before you change this setting.</para>
            <para>Default: selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Translate reserved characters</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>mapchars</option> or <option>nomapchars</option></para>
            <para>Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterisk, greater than, and less than characters) to the remap range (above 0xF000), which also allows the client side to recognize files created with such characters by &Windows;’s POSIX emulation. This can also be useful when mounting to most versions of &Samba;. This has no effect if the server does not support Unicode.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Do not send byte range lock requests</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>nobrl</option></para>
            <para>Do not send byte range lock requests to the server. This is necessary for certain applications that break with cifs style mandatory byte range locks (and most cifs servers do not yet support requesting advisory byte range locks).</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>SMB protocol version</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>vers=VERS</option></para>
            <para>Define which version of the SMB protocol is to be used. Normally, this option does not need to be enabled because the protocol version is negotiated between the client and the server.</para>
            <para>The following values are allowed:</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>1.0 (Classic &CIFS;/SMBv1 protocol)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the classic &CIFS;/SMBv1 protocol.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>2.0 (Windows Vista SP1/Windows Server 2008)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv2.002 protocol. This was initially introduced in &Microsoft; &Windows; Vista Service Pack 1 and &Windows; Server 2008.</para>
                  <para>Please note that the initial release version of &Microsoft; &Windows; Vista spoke a slightly different dialect (2.000) that is not supported.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>2.1 (Windows 7/Windows Server 2008R2)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv2.1 protocol that was introduced in &Microsoft; &Windows; 7 and &Windows; Server 2008R2.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>3.0 (Windows 8/Windows Server 2012)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv3.0 protocol that was introduced in &Microsoft; &Windows; 8 and &Windows; Server 2012.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>3.0.2 (Windows 8.1/Windows Server 2012R2)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv3.0.2 protocol that was introduced in &Microsoft; &Windows; 8.1 and &Windows; Server 2012R2.</para>
                </listitem>
              </varlistentry>
              
              <varlistentry>
                <term>
                  <menuchoice><guibutton>3.1.1 (Windows Server 2016)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv3.1.1 protocol that was introduced in &Microsoft; &Windows; Server 2016.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>3 (Version 3.0 and above)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use the SMBv3.0 protocol version and above.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>default (Negotiate the highest version)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to try to negotiate the highest SMBv2+ version supported by both the client and server.</para>
                </listitem>
              </varlistentry>
            </variablelist>
            <para>Default: not selected; VERS: <guibutton>default (Negotiate the highest version)</guibutton></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Cache mode</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Option: <option>cache=ARG</option></para>
            <para>Define how read and write requests are handled. In case you choose to not cache file data at all, the client never utilizes the cache for normal reads and writes. It always accesses the server directly to satisfy a read or write request. If you choose to follow the &CIFS;/SMB2 protocol strictly, the cache is only trusted if the client holds an oplock. If the client does not hold an oplock, then the client bypasses the cache and accesses the server directly to satisfy a read or write request. Choosing to allow loose caching semantics can sometimes provide better performance on the expense of cache coherency. This option might cause data corruption, if several clients access the same set of files on the server at the same time. Because of this, the strict cache mode is recommended.</para>
            <para>The following values are allowed:</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Do not cache file data at all</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to not cache file data at all.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Follow the &CIFS;/SMB2 protocol strictly</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to follow the &CIFS;/SMB2 protocol strictly.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Allow loose caching semantics</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to allow loose caching semantics.</para>
                </listitem>
              </varlistentry>
            </variablelist>
            <para>Default: not selected; ARG: <guibutton>Follow the &CIFS;/SMB2 protocol strictly</guibutton></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Security mode</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Security mode. To be able to use this option, the &CIFS; kernel module 1.40 or later is needed.</para>
            <para>The allowed values are:</para>
            <variablelist>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Connect as a null user (no name)</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=none</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to attempt to connect as a null user (no name).</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Kerberos 5 authentication</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=krb5</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use Kerberos version 5 authentication.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>Kerberos 5 authentication and packet signing</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=krb5i</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use Kerberos version 5 authentication and force packet signing.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLM protocol</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlm</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLM password hashing. Up to &Linux; kernel version 3.8 this is the default setting.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLM protocol and packet signing</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlmi</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLM password hashing and force packet signing.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLMv2 protocol</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlmv2</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLMv2 password hashing.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLMv2 protocol and packet signing</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlmv2i</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLMv2 password hashing and force packet signing.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLMSSP protocol</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlmssp</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLMv2 password hashing encapsulated in a Raw NTLMSSP message. Since &Linux; kernel version 3.8 this is the default setting.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>
                  <menuchoice><guibutton>NTLMSSP protocol and packet signing</guibutton></menuchoice>
                </term>
                <listitem>
                  <para>The <option>sec=ntlmssp</option> command line argument is used. This causes <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> to use NTLMv2 password hashing encapsulated in a Raw NTLMSSP message and force packet signing.</para>
                </listitem>
              </varlistentry>
            </variablelist>
            <para>Default: not selected; <guibutton>NTLMSSP protocol</guibutton></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Additional options</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Define additional options for use with <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>. Clicking the edit button to the right of the line edit opens an input dialog where the options have to be provided in a comma-separated list. After clicking <guibutton>OK</guibutton> in the input dialog, the options will be checked against a whitelist. All valid entries are accepted and entered into to line edit.</para>
            <para>Default: not selected; empty</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>
    
<!--
      Configuring Smb4K : Mounting : Mount Settings (BSD)
-->

    <sect2 id="configuration_page_mounting_mount_settings">
      <title>Mount Settings (BSD only)</title>
      
      <para>The <guilabel>Mount Settings</guilabel> tab is only available under FreeBSD, NetBSD and DragonFly BSD. The settings present under &Linux; can be found in the <link linkend="configuration_page_mounting_common_mount_settings">Common Mount Settings (&Linux; only)</link> and <link linkend="configuration_page_mounting_advanced_mount_settings">Advanced Mount Settings (&Linux; only)</link> sections.</para>
      
      <sect3 id="configuration_page_mounting_mount_settings_common_options">
        <title>Common Options</title>
        
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>User ID</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Sets the owner of the files and directories on the file system. By default, your UID is used. To change the UID, press the search button and choose one from the drop down menu.</para>
              <para>Default: your UID</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Group ID</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Sets the group that owns the files and directories on the file system. By default, your GID is used. To change the GID, press the search button and choose one from the drop down menu.</para>
              <para>Default: your GID</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>File mode</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Sets the permissions that are applied to files. The value is given in octal and has to have 4 digits. To learn more about the file mode, you should read the <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask(2)"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
              <para>Default: 0755</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Directory mode</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Sets the permissions that are applied to directories. The value is given in octal and has to have 4 digits. To learn more about the directory mode (dir_mode), you should read the <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask(2)"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
              <para>Default: 0755</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
      
      <sect3 id="configuration_page_mounting_mount_settings_character_sets">
        <title>Character Sets</title>
        
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use character sets</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Use the specified local and server's character sets.</para>
              <para>Default: not selected</para>
              <variablelist>
                <varlistentry>
                  <term>
                    <menuchoice><guibutton>Client character set</guibutton></menuchoice>
                  </term>
                  <listitem>
                    <para>Use this character set for the client side. These character sets are available:</para>
                    <variablelist>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>default</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Default character set used by the client's kernel.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-1</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-1:1998. This character-encoding scheme is used throughout the Americas, Western Europe, Oceania, and much of Africa.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-2</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-2:1999.  It is informally referred to as "Latin-2". It is generally intended for Central or "Eastern European" languages that are written in the Latin script.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-3</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-3:1999. It is informally referred to as Latin-3 or South European. It was designed to cover Turkish, Maltese and Esperanto, though the introduction of ISO/IEC 8859-9 superseded it for Turkish.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-4</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-4:1998. It is informally referred to as Latin-4 or North European. It was designed to cover Estonian, Latvian, Lithuanian, Greenlandic, and Sami. It has been largely superseded by ISO/IEC 8859-10 and Unicode.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-5</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-5:1999. It is informally referred to as Latin/Cyrillic. It was designed to cover languages using a Cyrillic alphabet such as Bulgarian, Belarusian, Russian, Serbian and Macedonian but was never widely used.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-6</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-6:1999. It is informally referred to as Latin/Arabic. It was designed to cover Arabic.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-7</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-7:2003. It is informally referred to as Latin/Greek. It was designed to cover the modern Greek language.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-8</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-8:1999. It is informally referred to as Latin/Hebrew. ISO/IEC 8859-8 covers all the Hebrew letters, but no Hebrew vowel signs.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-9</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-9:1999. It is informally referred to as Latin-5 or Turkish. It was designed to cover the Turkish language, designed as being of more use than the ISO/IEC 8859-3 encoding.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-13</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-13:1998. It is informally referred to as Latin-7 or Baltic Rim. It was designed to cover the Baltic languages, and added characters used in the Polish language missing from the earlier encodings ISO 8859-4 and ISO 8859-10. Unlike these two, it does not cover the Nordic languages.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-14</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-14:1998. It is informally referred to as Latin-8 or Celtic. It was designed to cover the Celtic languages, such as Irish, Manx, Scottish Gaelic, Welsh, Cornish, and Breton.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>iso8859-15</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>ISO/IEC 8859-15:1999. It is informally referred to as Latin-9 (and for a while Latin-0). It is similar to ISO 8859-1, and thus also intended for “Western European” languages, but replaces some less common symbols with the euro sign and some letters that were deemed necessary.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>utf8</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Unicode (or Universal Coded Character Set) Transformation Format – 8-bit. UTF-8 is used by many &Linux; distributions as default character set, and is, in addition, by far the most common encoding for the World Wide Web.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>koi8-r</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>KOI8-R (RFC 1489) is an 8-bit character encoding, derived from the KOI-8 encoding by the programmer Andrei Chernov in 1993 and designed to cover Russian, which uses a Cyrillic alphabet.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>koi8-u</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>KOI8-U (RFC 2319) is an 8-bit character encoding, designed to cover Ukrainian, which uses a Cyrillic alphabet.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>koi8-ru</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>KOI8-RU is an 8-bit character encoding, designed to cover Russian, Ukrainian, and Belarusian which use a Cyrillic alphabet.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1251</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Windows-1251 is an 8-bit character encoding, designed to cover languages that use the Cyrillic script such as Russian, Bulgarian, Serbian Cyrillic and other languages. In Linux, the encoding is known as cp1251.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>gb2312</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>GB/T 2312-1980 is a key official character set of the People's Republic of China, used for Simplified Chinese characters. GB2312 is the registered internet name for EUC-CN, which is its usual encoded form. GB/T 2312-1980 has been superseded by GBK and GB18030, which include additional characters, but GB/T 2312 remains in widespread use as a subset of those encodings. </para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>big5</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Big-5 or Big5 is a Chinese character encoding method used in Taiwan, Hong Kong, and Macau for traditional Chinese characters. The People's Republic of China (PRC), which uses simplified Chinese characters, uses the GB 18030 character set instead.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>euc-jp</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>EUC-JP is a variable-width encoding used to represent the elements of three Japanese character set standards, namely JIS X 0208, JIS X 0212, and JIS X 0201.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>euc-kr</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>EUC-KR is a variable-width encoding to represent Korean text using two coded character sets, KS X 1001 (formerly KS C 5601) and either ISO 646:KR (KS X 1003, formerly KS C 5636) or US-ASCII, depending on variant. KS X 2901 (formerly KS C 5861) stipulates the encoding and RFC 1557 dubbed it as EUC-KR.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>tis-620</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Thai Industrial Standard 620-2533, commonly referred to as TIS-620, is the most common character set and character encoding for the Thai language.</para>
                        </listitem>
                      </varlistentry>
                    </variablelist>
                    <para>Default: <guimenuitem>default</guimenuitem></para>
                  </listitem>
                </varlistentry>
                <varlistentry>
                  <term>
                    <menuchoice><guibutton>Server character set</guibutton></menuchoice>
                  </term>
                  <listitem>
                    <para>Use this character set for the server side. These character sets are available:</para>
                    <variablelist>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>default</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Default character set used by the server.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp437</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 437 is the character set of the original IBM PC (personal computer). It is also known as CP437, OEM-US, OEM 437, PC-8, or DOS Latin US. The set includes all printable ASCII characters, extended codes for accented letters (diacritics), some Greek letters, icons, and line-drawing symbols.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp720</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 720 is a code page used to write Arabic in Egypt, Iraq, Jordan, Saudi Arabia, and Syria.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp737</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 737 is a code page used to write the Greek language in Greece.</para>
                        </listitem>
                      </varlistentry> 
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp775</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 775 is a code page used to write the Estonian, Lithuanian and Latvian languages.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp850</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 850 is a code page used in Western Europe.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp852</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 852 is a code page used to write Central European languages that use Latin script (such as Bosnian, Croatian, Czech, Hungarian, Polish, Romanian, Serbian, Slovak or Slovene).</para>
                        </listitem>
                      </varlistentry> 
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp855</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 855 is a code page used to write Cyrillic script. Code page 872 is the euro currency update of code page 855.</para>
                        </listitem>
                      </varlistentry> 
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp857</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 857 is a code page used in Turkey to write Turkish. It is based on code page 850, but with many changes. It includes all characters from ISO 8859-9.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp858</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 858 is a code page used to write Western European languages. Like code page 850, Code page 858 supports the entire repertoire of ISO 8859-1, but in a different arrangement.</para>
                        </listitem>
                      </varlistentry>   
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp860</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 860 is a code page used in Portugal to write Portuguese, and it is also suitable to write Spanish and Italian.</para>
                        </listitem>
                      </varlistentry>                        
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp861</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 861 is a code page used in Iceland to write the Icelandic language (as well as other Nordic languages).</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp862</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 862 is a code page in Israel for Hebrew.</para>
                        </listitem>
                      </varlistentry>  
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp863</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 863 is a code page used in Canada to write French (mainly in Quebec) although it lacks some letters.</para>
                        </listitem>
                      </varlistentry>  
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp864</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 864 is a code page used to write Arabic in Egypt, Iraq, Jordan, Saudi Arabia, and Syria.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp865</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 865 is a code page used in Denmark and Norway to write Nordic languages (except Icelandic, for which code page 861 is used).</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp866</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 866 is a code page used in Russia to write Cyrillic script.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp869</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 869 is a code page used to write Greek language.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp874</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 874, also known as Code page 9066, is used to write the Thai language.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp932</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 932 is the &Microsoft; &Windows; code page for the Japanese language, which is an extended variant of the Shift JIS Japanese character encoding.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp936</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 936 is the &Microsoft; &Windows; code page for simplified Chinese.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp949</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 949 is the &Microsoft; &Windows; code page for the Korean language.</para>
                        </listitem>
                      </varlistentry> 
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp950</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 950 is the &Microsoft; &Windows; code page for Traditional Chinese.</para>
                        </listitem>
                      </varlistentry> 
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1250</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1250 is a &Microsoft; &Windows; code page to represent texts in Central European and Eastern European languages that use Latin script, such as Polish, Czech, Slovak, Hungarian, Slovene, Bosnian, Croatian, Serbian (Latin script), Romanian (before 1993 spelling reform) and Albanian. It may also be used with the German language.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1251</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1251 is a &Microsoft; &Windows; code page designed to cover languages that use the Cyrillic script such as Russian, Bulgarian, Serbian Cyrillic, and other languages.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1252</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1252 is a &Microsoft; &Windows; code page used for English and many European languages including Spanish, French, and German.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1253</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1253 is a &Microsoft; &Windows; code page used to write modern Greek. It is not capable of supporting the older polytonic Greek.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1254</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1254 is a &Microsoft; &Windows; code page used to write Turkish.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1255</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1255 is a &Microsoft; &Windows; code page used to write Hebrew.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1256</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1256 is a &Microsoft; &Windows; code page write Arabic (and possibly some other languages that use Arabic script, like Persian and Urdu).</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1257</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1257 is a &Microsoft; &Windows; code page to support the Estonian, Latvian and Lithuanian languages.</para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>cp1258</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Code page 1258 is a &Microsoft; &Windows; code page to represent Vietnamese texts. It makes use of combining diacritical marks. </para>
                        </listitem>
                      </varlistentry>
                      <varlistentry>
                        <term>
                          <menuchoice><guimenuitem>unicode</guimenuitem></menuchoice>
                        </term>
                        <listitem>
                          <para>Unicode is an information technology standard for the consistent encoding, representation, and handling of text expressed in most of the world's writing systems.</para>
                        </listitem>
                      </varlistentry>
                    </variablelist>
                    <para>Default: <guilabel>default</guilabel></para>
                  </listitem>
                </varlistentry>
              </variablelist>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>
  </sect1>

<!-- 
      Configuring Smb4K : Synchronization 
-->

  <sect1 id="configuration_page_synchronization">
    <title>Synchronization</title>

    <para>This configuration page contains options that influence the behavior of the <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command that is used to synchronize remote shares with local copies and vice versa. It is only available, if <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is installed on your system. It is recommended that you read the <ulink url="man:/rsync">manual page</ulink> before you use the synchronization feature the first time. However, safe settings are pre-defined. You will do no harm, if you start right away.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Synchronization" configuration page</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_synchronization.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Synchronization" configuration page</phrase></textobject>
      </mediaobject>
    </screenshot>

<!-- 
      Configuring Smb4K : Synchronization : Basic Settings
-->
    
    <sect2 id="configuration_page_synchronisation_basic_settings">
      <title>Basic Settings</title>
      
      <sect3 id="configuration_page_synchronization_basic_settings_default_destination">
        <title>Synchronization Directory</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Synchronization prefix</guibutton></menuchoice>
            </term>
            <listitem>
              <para>This is the base folder below which &smb4k; stores the transferred data using <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>. It can be changed by using the &URL; requester (Click the button with the folder icon.) or by directly entering the new path into the text box. Path variables like $HOME are recognized.</para>
              <para>For each share you synchronize, a new subdirectory below this prefix will be generated. If you want to synchronize the contents of a share to a different folder, you can define it in the <link linkend="shares_view_synchronization">synchronization dialog</link>.</para>
              <para>Default: <filename class="directory">$HOME/smb4k_sync/</filename></para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
      
      <sect3 id="configuration_page_synchronisation_basic_settings_behavior">
        <title>Behavior</title>
        
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Archive mode</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-a</option>/<option>--archive</option>, same as <option>-rlptgoD</option> (no <option>-A</option>, <option>-X</option>, <option>-U</option>, <option>-N</option>, <option>-H</option>)</para>
              <para>Switch the archive mode on. This is a quick way of saying you want recursion and want to preserve almost everything. Note that <option>-a</option> does not preserve hardlinks (<option>-H</option>), access control lists (ACLs, <option>-A</option>), extended attributes (xattrs, <option>-X</option>), access (use) times (<option>-U</option>) nor create times (<option>-N</option>). You must separately specify these options. The only exception to the above equivalence is when <option>--files-from</option> is specified, in which case <option>-r</option> is not implied.</para>
              <para>In case you do not want to run <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> in archive mode, choose the appropriate arguments in the settings yourself.</para>
              <para>Default: selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Recurse into subdirectories</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-r</option>/<option>--recursive</option></para>
              <para>Recurse into subdirectories.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use relative path names</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-R</option>/<option>--relative</option></para>
              <para>Use relative path names. This means that the full path names specified on the command line are sent to the server rather than just the last parts of the file names.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Do not send implied directories</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--no-implied-dirs</option></para>
              <para>This option affects the default behavior of the <option>--relative</option> option. When it is specified, the attributes of the implied directories from the source names are not included in the transfer. This means that the corresponding path elements on the destination system are left unchanged if  they  exist, and any missing implied directories are created with default attributes. This even allows these implied path elements to have big differences, such as being a symlink to a folder on one side of the transfer, and a real folder on the other side.</para>
              <para>For further information you ought to read the <ulink url="man:/rsync">manual page</ulink>.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Transfer directories without recursing</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-d</option>/<option>--dirs</option></para>
              <para>Tell the sending side to include any directories that are encountered. Unlike <option>--recursive</option>, a folders contents is not copied unless the folder name specified is "." or ends with a trailing slash (&eg; ".", "dir/.", "dir/", &etc;). Without this option or the <option>--recursive</option> option, <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> will skip all directories it encounters (and output a message to that effect for each one). If you specify both <option>--dirs</option> and <option>--recursive</option>, <option>--recursive</option> takes precedence.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
      
      <sect3 id="configuration_page_synchronization_basic_settings_backup">
        <title>Backups</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Make backups</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-b</option>/<option>--backups</option></para>
              <para>With this option, preexisting destination files are renamed as each file is transferred or deleted. You can control where the backup file goes and what (if any) suffix gets appended using the <option>--backup-dir</option> and <option>--suffix</option> options.</para>
              <para>Note that if you don't specify <option>--backup-dir</option>, (1) the <option>--omit-dir-times</option> option will be implied, and (2) if <option>--delete</option> is also in effect (without <option>--delete-excluded</option>),  <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> will add a "protect" filter-rule for the backup suffix to the end of all your existing excludes (&eg; <option>-f "P *~"</option>). This will prevent previously backed-up files from being deleted. Note that if you are supplying your own filter rules, you may  need  to  manually insert your own exclude/protect rule somewhere higher up in the list so that it has a high enough priority to be effective (&eg;, if  your rules specify a trailing inclusion/exclusion of '*', the auto-added rule would never be reached).</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Backup suffix</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--suffix=SUFFIX</option></para>
              <para>This  option  allows  you  to override the default backup suffix used with the <option>--backup</option> option. The default suffix is a <emphasis>~</emphasis> if no <option>--backup-dir</option> was specified, otherwise it is an empty string.</para>
              <para>This option is only available if you ticked the <guilabel>Make backups</guilabel> option above.</para>
              <para>Default: not selected; SUFFIX: ~</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Backup directory</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--backup-dir=DIR</option></para>
              <para>In combination with the <option>--backup</option> option, this tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to store all backups in the specified folder. This is very useful for incremental backups. You can additionally specify a backup suffix using the <option>--suffix</option> option (otherwise the files backed up in the specified folder will keep  their original filenames).</para>
              <para>This option is only available if you ticked the <guilabel>Make backups</guilabel> option above.</para>
              <para>Default: not selected; DIR: <envar>$HOME</envar></para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
      
    </sect2>
    
<!--
      Configuring Smb4K : Synchronization : File Handling
-->

    <sect2 id="configuration_page_synchronization_file_handling">
      <title>File Handling</title>

      <sect3 id="configuration_page_synchronization_file_handling_general">
        <title>General</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Update files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-u</option>/<option>--update</option></para>
              <para>This forces <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to skip any files that exist on the destination and have a modification time that is newer than the one of the source file. (If an existing destination file has a modification time equal to the source file's, it will be updated if the sizes are different.)</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Update files in place</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--inplace</option></para>
              <para>This causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> not to create a new copy of the file and then move it into place. Instead <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> will overwrite the  existing file, meaning that the rsync algorithm cannot accomplish the full amount of network reduction it might be able to otherwise.  One exception to this is if you combine the option with <option>--backup</option>, since <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is smart enough to use the backup file as the basis file for the transfer.</para>
              <para>For further information you ought to read the <ulink url="man:/rsync">manual page</ulink>.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Handle sparse files efficiently</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-S</option>/<option>--sparse</option></para>
              <para>Try to handle sparse files efficiently so they take up less space on the destination. Conflicts with <option>--inplace</option> because it's not possible to overwrite data in a sparse fashion.</para>
              <note><para>Do not use this option when the destination is a &Solaris; "tmpfs" file system. It doesn't seem to handle seeks over null regions correctly and ends up corrupting the files.</para></note>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Copy files whole (no rsync algorithm)</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-W</option>/<option>--whole-file</option></para>
              <para>With this option the incremental <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> algorithm is not used and the whole file is sent as-is instead. The transfer may be faster if this option is used when the bandwidth between the source and destination machines is higher than the bandwidth to disk (especially when the "disk" is actually a networked file system). This is the default when both the source and destination are specified as local paths.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Only update files that already exist</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--existing</option>/<option>--ignore-non-existing</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to skip updating files that do not exist yet on the destination. If this option is combined with the <option>--ignore-existing</option> option, no files will be updated (which can be useful if all you want to do is to delete missing files).</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Ignore files that already exist</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--ignore-existing</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to skip updating files that already exist on the destination. See also <option>--ignore-non-existing</option>.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_file_handling_links">
        <title>Links</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-l</option>/<option>--links</option></para>
              <para>Copy symlinks as symlinks.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Transform symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-L</option>/<option>--copy-links</option></para>
              <para>When symlinks are encountered, the item that they point to is copied, rather than the symlink.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Transform unsafe symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--copy-unsafe-links</option></para>
              <para>Only transform "unsafe" symlinks. This means if a symlink is encountered that is pointing outside the copied tree, the referenced item is transferred rather than the symlink itself.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Ignore unsafe symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--safe-links</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to ignore any symbolic links which point outside the copied tree. All absolute symlinks are also ignored. Using this option in conjunction with <option>--relative</option> may give unexpected results.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Munge symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--munge-links</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to (1) modify all symlinks on the receiving side in a way that makes them unusable but recoverable, or (2) to unmunge symlinks on the sending side that had been stored in a munged state. This is useful if you do not quite trust the source of the data to not try to slip in a symlink to an unexpected place. For further information on this argument, please see the manual page of <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>          
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve hard links</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-H</option>/<option>--hard-links</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to look for hard-linked files in the transfer and link together the corresponding files on the receiving side. Without this option, hard-linked files in the transfer are treated as though they were separate files.</para>
              <para>Note that <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> can only detect hard links if both parts of the link are in the list of files being sent.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Copy directory symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-k</option>/<option>--copy-dirlinks</option></para>
              <para>This option causes the sending side to treat a symlink to a directory as though it were a real directory.  This is useful if you don’t want symlinks to non-directories to be affected, as they would be using <option>--copy-links</option>.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Keep directory symlinks</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-K</option>/<option>--keep-dirlinks</option></para>
              <para>This option causes the receiving side to treat a symlink to a directory as though it were a real directory, but only if it matches a real directory from the sender. Without this option, the receiver's symlink would be deleted and replaced with a real directory.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>

    <sect2 id="configuration_page_synchronization_attributes_ownership">
      <title>File Attributes &amp; Ownership</title>
      <sect3 id="configuration_page_synchronization_attributes_ownership_attributes">
        <title>File Attributes</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve permissions</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-p</option>/<option>--perms</option></para>
              <para>This option causes the receiving side to set the destination permissions to be the same as the source permissions.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve access control lists (ACLs)</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-A</option>/<option>--acls</option></para>
              <para>Preserve access control lists. This option causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to update the destination ACLs to be the same as the source ACLs. The option also implies --perms. The source and destination systems must have compatible ACL entries for this option to work properly.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve extended attributes</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-X</option>/<option>--xattrs</option></para>
              <para>Preserve extended attributes. This option causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to update the destination extended attributes to be the same as the source ones.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve access times</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-U</option>/<option>--atimes</option></para>
              <para>Preserve access times. This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to set the access (use) times of the destination files to the same value as the source files.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve create times</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-N</option>/<option>--crtimes</option></para>
              <para>Preserve create times. This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to set the create times (newness) of the destination files to the same value as the source files.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve device and special files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-D</option>/<option>--devices --specials</option></para>
              <para>This option causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to transfer character and block device files as well as special files (such as named sockets and fifos) to the remote system. This option has no effect if the receiving side is not run as the super user and <option>--super</option> is not specified.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve times</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-t</option>/<option>--times</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to transfer modification times along with the files and update them on the remote system.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Omit directories when preserving times</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-O</option>/<option>--omit-dir-times</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to omit directories when it is preserving modification times (see <option>--times</option>).</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
      
      <sect3 id="configuration_page_synchronization_attributes_ownership_ownership">
        <title>Ownership</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve owner</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-o</option>/<option>--owner</option></para>
              <para>This option causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to set the owner of the destination file to be the same as the one of the source file. By default, the preservation is done by name, but may fall back to using the ID number in some circumstances (see the <option>--numeric-ids</option> option for a full discussion). This option has no effect if the receiving <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is not run as the super user and <option>--super</option> is not specified.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Preserve group</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-g</option>/<option>--group</option></para>
              <para>This option causes <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to set the group of the destination file to be the same as the on of the source file. If the receiving program is not running as the super-user (or with the <option>--no-super</option> option), only groups that the receiver is a member of will be preserved.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>

<!-- 
      Configuring Smb4K : Synchronization : File Transfer
-->

    <sect2 id="configuration_page_synchronization_file_transfer">
      <title>File Transfer</title>
      <sect3 id="configuration_page_synchronization_file_transfer_compression">
        <title>Compression</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Compress data during transfer</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-z</option>/<option>--compress</option></para>
              <para>Compress file data during the transfer.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set compression level</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--compress-level=NUM</option></para>
              <para>Explicitly set the compression level to use. If NUM is non-zero, the <option>--compress</option> argument is implied.</para>
              <para>Default: not selected; NUM: 0</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Skip compression for following file suffixes</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--skip-compress=LIST</option></para>
              <para>Overwrite the list of file suffixes that will not be compressed. The LIST should be one or more file suffixes (without the dot) separated by slashes. You may specify an empty string to indicate that no file should be skipped. The default list of suffixes will be replaced by this list. For further details, see the <ulink url="man:/rsync"><citerefentry><refentrytitle>manual page of rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
              <para>Default: not selected; LIST: empty</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_file_transfer_files">
        <title>Files</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Do not transfer any file smaller than</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--min-size=SIZE</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to avoid transferring any file that is smaller than the specified SIZE, which can help in not transferring small, junk files.</para>
              <para>Default: not selected; SIZE: 0 kB</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Do not transfer any file larger than</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--max-size=SIZE</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to avoid transferring any file that is larger than the specified SIZE.</para>
              <para>Default: not selected; SIZE: 0 kB</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Keep partially transferred files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--partial</option></para>
              <para>By default, <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> will delete any partially transferred file if the transfer is interrupted. In some circumstances it is more desirable to keep partially transferred files. Using the <option>--partial</option> option tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to keep the partial file which should make a subsequent transfer of the rest of the file much faster.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Put partially transferred files into</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--partial-dir=DIR</option></para>
              <para>A better way to keep partial files than the <option>--partial</option> option is to specify a folder DIR that will be used to hold the partial data (instead of writing it out to the  destination file). On the next transfer, <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> will use a file found in this folder as data to speed up the resumption of the transfer and then delete it after it has served its purpose. Before you tick this option, you should read the <ulink url="man:/rsync">manual page</ulink>.</para>
              <para>Default: not selected; DIR: <filename class="directory">$HOME</filename></para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_file_transfer_miscellaneous">
        <title>Miscellaneous</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set bandwidth limit:</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--bwlimit=RATE</option></para>
              <para>Set the maximum data transfer RATE in kilobytes per second.</para>
              <para>Default: not selected; RATE: 0 kB/s</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>

<!--
      Configuring Smb4K : Synchronization : File Deletion
-->

    <sect2 id="configuration_page_synchronization_file_deletion">
      <title>File Deletion</title>

      <sect3 id="configuration_page_synchronization_file_deletion_files_directories">
        <title>Files &amp; Directories</title>
      
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Remove synchronized source files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--remove-source-files</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to remove from the sending side the files (meaning non-directories) that are a part of the transfer and have been successfully duplicated on the receiving side.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete extraneous files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delete</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to delete extraneous files from  the  receiving side (ones  that  aren't on the sending side), but only for the directories that are being synchronized.  You must have asked <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to send the whole folder (&eg; "<filename class="directory">dir</filename>" or "<filename class="directory">dir/</filename>") without using a wildcard for the folders contents (&eg; "<filename class="directory">dir/*</filename>") since the wildcard is expanded by the shell and <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> thus gets a request to transfer individual files, not the files' parent folder. Files that are excluded from transfer are also excluded from being deleted unless you use the <option>--delete-excluded</option> option or mark the rules as only matching on the sending side.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete files before transfer</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delete-before</option></para>
              <para>Request that the file deletions on the receiving side be done before the transfer starts. This is the default if <option>--delete</option> or <option>--delete-excluded</option> is specified without one of the <option>--delete-WHEN</option> options.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete files after transfer</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delete-after</option></para>
              <para>Request that the file deletions on the receiving side be done after the transfer has completed.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete files during transfer</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delete-during</option></para>
              <para>Request that the file deletions on the receiving side be done incrementally as the transfer happens. This is a faster method than choosing the before- or after-transfer algorithm, but it is only supported beginning with <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> version 2.6.4.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete excluded files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delete-excluded</option></para>
              <para>In addition to deleting the files on the receiving side that are not on the sending side, this tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to also delete any files on the receiving side that are excluded (see <option>--exclude</option>).</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delete even if I/O errors occur</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--ignore-errors</option></para>
              <para>Tells <option>--delete</option> to go ahead and delete files even when there are I/O errors.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Force deletion of non-void directories</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--force</option></para>
              <para>This option tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to delete a non-empty folder when it is to be replaced by a non-folder. This is only relevant if deletions are not active (see <option>--delete</option>).</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_filedel_restrict">
        <title>Restrictions</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Do not delete more than this many files</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--max-delete=NUM</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> not to delete more than NUM files or directories (NUM must be non-zero). This is useful when mirroring very large trees to prevent disasters.</para>
              <para>Default: not selected; NUM: 0</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

    </sect2>

<!-- 
      Configuring Smb4K : Synchronization : Filtering 
-->

    <sect2 id="configuration_page_synchronization_filter">
      <title>Filtering</title>   

      <sect3 id="configuration_page_synchronization_filter_general">
        <title>General</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Auto-ignore files in the same way CVS does</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-C</option>/<option>--cvs-exclude</option></para>
              <para>This is a useful shorthand for excluding a broad range of files that you often don't want to transfer between systems. It uses the same algorithm that CVS uses to determine if a file should be ignored.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Exclude files matching this pattern</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--exclude=PATTERN</option></para>
              <para>This  option is a simplified form of the <option>--filter</option> option that defaults to an exclude rule and does not allow the full rule-parsing syntax of normal filter rules.</para>
              <para>Default: not selected; PATTERN: empty</para>
            </listitem>             
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Read exclude patterns from</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--exclude-from=FILE</option></para>
              <para>This option is related to the <option>--exclude</option> option, but it specifies a FILE that contains exclude patterns (one per line). Blank lines in the file  and lines starting with ';' or '#' are ignored. You have to choose an existing file to make this option work.</para>
              <para>Default: not selected; FILE: <filename>$HOME/exclude.txt</filename></para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Include files matching this pattern</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--include=PATTERN</option></para>
              <para>This option is a simplified form of the <option>--filter</option> option that defaults to an include rule and does not allow the full rule-parsing syntax of normal filter rules.</para>
              <para>Default: not selected; PATTERN: empty</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Read include patterns from</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--include-from=FILE</option></para>
              <para>This option is related to the <option>--include</option> option, but it specifies a FILE that contains include patterns (one  per  line). Blank lines in the file and lines starting with ';' or '#' are ignored. You have to choose an existing file to make this option work.</para>
              <para>Default: not selected; FILE: <filename>$HOME/include.txt</filename></para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_filter_rules">
        <title>Filter Rules</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use --filter='dir-merge /.rsync-filter' filter rule</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-F</option></para>
              <para>This option tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to look for per-folder <filename>.rsync-filter</filename> files that have been sprinkled through the hierarchy and use their rules to filter the files in the transfer.</para>
              <para>See the FILTER RULES section of the <ulink url="man:/rsync">manual page</ulink> for detailed information on how this option works.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Use --filter='exclude .rsync-filter' filter rule</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-FF</option></para>
              <para>This option filters out the <filename>.rsync-filter</filename> files themselves from the transfer.</para>
              <para>See the FILTER RULES section of the <ulink url="man:/rsync">manual page</ulink> for detailed information on how this option works.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Custom filter rules</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-f</option>/<option>--filter=RULE</option></para>
              <para>You can define one or more filter rules here. Each rule has to be prefixed with the <option>--filter=</option> or <option>-f</option> option string, because the contents of the text box will be passed to the <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command AS IS.</para>
              <para>This option allows you to add rules to selectively exclude  certain  files  from  the  list of files to be transferred. This is most useful in combination with a recursive transfer.</para>
              <para>You may use as many <option>--filter</option> options as you like to build up the list of files to exclude.</para>
              <para>See  the  FILTER  RULES section of the <ulink url="man:/rsync">manual page</ulink> for detailed information on this option.</para>
              <para>Default: not selected; RULES: empty</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>
    </sect2>

<!-- 
      Configuring Smb4K : Synchronization : Miscellaneous
-->

    <sect2 id="configuration_page_synchronization_miscellaneous">
      <title>Miscellaneous</title>

      <sect3 id="configuration_page_synchronization_miscellaneous_checksums">
        <title>Checksums</title>

        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Force fixed checksum block size</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-B</option>/<option>--block-size=SIZE</option></para>
              <para>This forces the block size used in the rsync algorithm to a fixed value. It is normally selected based on the size of each file being updated. See the <ulink url="http://rsync.samba.org/tech_report/">technical report</ulink> for details.</para>
              <para>Default: not selected; SIZE: 0</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Set block/file checksum seed</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--checksum-seed=NUM</option></para>
              <para>Set the MD4 checksum seed to the integer NUM. This 4 byte checksum seed is included in each block and file MD4 checksum calculation. By default the checksum seed is generated by the server and defaults to the current time(). This option is used to set a specific checksum seed, which is useful for applications that want repeatable block and file checksums, or in the case where the user wants a more random checksum seed. Note that setting NUM to 0 causes rsync to use the default of  time() for checksum seed.</para>
              <para>Default: not selected; NUM: 0</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Skip files based on checksum</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-c</option>/<option>--checksum</option></para>
              <para>This forces the sender to checksum every regular file using a 128-bit MD4 checksum. It does this during the initial file system scan as it builds the list of all available files. The receiver then checksums its version of each file (if it exists and  it  has  the  same  size as its sender-side counterpart) in order to decide which files  need  to  be  updated: files with either a changed size or a changed checksum are selected for transfer. Since this whole-file checksumming of  all files on both sides of the connection occurs in addition to the automatic checksum verifications that occur during a file's transfer, this option can be quite slow.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

      <sect3 id="configuration_page_synchronization_miscellaneous_miscellaneous">
        <title>Miscellaneous</title>
        <variablelist>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Do not cross file system boundaries</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>-x</option>/<option>--one-file-system</option></para>
              <para>This tells <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to avoid crossing a file system boundary when recursing. This does not limit the user's ability to specify items to copy from multiple file systems, just <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>'s recursion through the hierarchy of each folder that the user specified, and also the analogous recursion on the receiving side during deletion. Also keep in mind that <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> treats a "bind" mount to the same device as being on the same file system.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <menuchoice><guibutton>Delay updates until the end of transfer</guibutton></menuchoice>
            </term>
            <listitem>
              <para>Option: <option>--delay-updates</option></para>
              <para>This option puts the temporary file from each updated file into a holding folder until the end of the transfer, at which time all the files are renamed into place in rapid succession.</para>
              <para>It is strongly recommended that you read the <ulink url="man:/rsync">manual page</ulink> before using this option.</para>
              <para>Default: not selected</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </sect3>

    </sect2>
  </sect1>

<!--
      Configuring Smb4K : Authentication
-->

  <sect1 id="configuration_page_authentication">
    <title>Authentication</title>

    <para>Here you can enter the default login credentials. If you use profiles, they are only valid for the active profile.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Authentication" configuration page</screeninfo>
      <mediaobject>
        <imageobject>
          <imagedata fileref="configuration_page_authentication.png" format="PNG" />
        </imageobject>
        <textobject>
          <phrase>The "Authentication" configuration page</phrase>
        </textobject>
      </mediaobject>
    </screenshot>

    <para>All login credentials are stored in your password manager (&eg; &kwallet;, GNOME Keyring or KeePassXC). To change them, you can use the <link linkend="network_neighborhood_browser_authentication">password dialog</link> or your password manager. To delete individual entries, you need to use your password manager.</para>
  </sect1>

<!--
      Configuring Smb4K : Bookmarks
-->

  <sect1 id="configuration_page_bookmarks">
    <title>Bookmarks</title>

    <para>On this configuration page, you can edit your bookmarks. If you use profiles, only those of the active profile are shown.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Bookmarks" configuration page</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_bookmarks.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Bookmarks" configuration page</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>To edit a category or bookmark, double click it or select it and click the <guibutton>Edit</guibutton> button on the righthand side. Categories can directly be renamed. For bookmarks, the editor opens and you can set the label, the category and the username for login as well as the workgroup or domain and the ip address of its host.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Bookmarks" configuration page with open editor</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_bookmarks_editor.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Bookmarks" configuration page with open editor</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>Categories can be added by either using the <guibutton>Add Category</guibutton> button, or by entering a new category name in the editor. Individual entries or the entire list can be deleted by pressing the <guibutton>Remove</guibutton> or <guibutton>Clear List</guibutton> button. To undo your changes, click the <guibutton>Reset</guibutton> button.</para>
    <para>For further information about bookmarks, read this <link linkend="bookmarks">section</link>.</para>
  </sect1>


<!-- 
      Configuring Smb4K : Custom Settings
-->

  <sect1 id="configuration_page_custom_settings">
    <title>Custom Settings</title>

    <para>All servers and shares for which you defined custom settings are listed here. If you use profiles, only those of the active profile are shown.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Custom Settings" configuration tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_custom_settings.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Custom Settings" configuration tab</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>You can edit the custom settings for a network item by either double clicking it or by selecting it and clicking the <guibutton>Edit</guibutton> button on the righthand side. The editor will then open and you can change all the desired settings.</para>

    <screenshot>
      <screeninfo>Screenshot of the "Custom Settings" configuration page with open editor</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_custom_settings_editor.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Custom Settings" configuration page with open editor</phrase></textobject>
      </mediaobject>
    </screenshot>

    <para>To remove an entry, select it and click the <guibutton>Remove</guibutton> button. All network items may be removed at once by clicking the <guibutton>Clear List</guibutton> button. To reset your changes, click the <guibutton>Reset</guibutton> button.</para>
    <para>For further information about custom settings, read this <link linkend="custom_settings">section</link>.</para>
  </sect1>

<!-- 
      Configuring Smb4K : Profiles 
-->

  <sect1 id="configuration_page_profiles">
    <title>Profiles</title>
    
    <para>On this page you can enable the use of profiles and manage your profiles.</para>
    
    <screenshot>
      <screeninfo>Screenshot of the "Profiles" configuration tab</screeninfo>
      <mediaobject>
        <imageobject><imagedata fileref="configuration_page_profiles.png" format="PNG" /></imageobject>
        <textobject><phrase>The "Profiles" configuration tab</phrase></textobject>
      </mediaobject>
    </screenshot>

<!--
      Configuring Smb4K : Profiles : Settings 
-->

    <sect2 id="configuration_page_profiles_settings">
      <title>Settings</title>

      <variablelist>
        <varlistentry>
          <term>
            <menuchoice><guibutton>Use profiles</guibutton></menuchoice>
          </term>
          <listitem>
            <para>Make Smb4K use profiles. This enables you to define different bookmarks and custom settings for each profile. This is especially useful if you are using a laptop in different network neighborhoods, &eg; at home and at work. When enabling this setting the first time, the first entry in the <link linkend="configuration_page_profiles_profiles">profiles list</link> will be the active profile.</para>
            <para>Default: not selected</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>

<!-- 
      Configuring Smb4K : Profiles : Profiles 
  -->

    <sect2 id="configuration_page_profiles_profiles">
      <title>Profiles</title>

      <para>Here, you can manage your profiles. By default, there are two pre-defined ones (<guilabel>Home</guilabel> and <guilabel>Work</guilabel>). To add a new profile, enter it into the line edit and click the <guibutton>Add</guibutton> button. Entries can be deleted by selecting them and clicking the <guibutton>Remove</guibutton> button. To change the order, you can use the <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons. The active profile can be changed by either double clicking the profile name in the list or by selecting the profile and using the <guibutton>Set Active</guibutton> button. To rename a profile, select it and click the <guibutton>Rename</guibutton> button. You will then be able to change the name in the list widget. All settings of the renamed profile are migrated automatically. To reset your changes, click the <guibutton>Reset</guibutton> button.</para>
      <para>For further information about profiles, read this <link linkend="profiles">section</link>.</para>
    </sect2>
  </sect1>
</chapter>

<!-- 
      Command Reference 
-->

<chapter id="command_reference" >
  <title>Command Reference</title>

<!-- 
      Command Reference : The File Menu 
  -->

  <sect1 id="command_reference_file_menu">
    <title>The File Menu</title>

    <variablelist>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>File</guimenu>
            <guisubmenu>Profiles</guisubmenu>
          </menuchoice>
        </term>
        <listitem>
          <para>Select the profile to use. This menu entry is disabled if the user did not enabled the use of profiles.</para>
          <para>Two profiles are predefined:</para>
          <variablelist>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>File</guimenu>
                  <guisubmenu>Profiles</guisubmenu>
                  <guimenuitem>Home</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>A profile for use at home</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>File</guimenu>
                  <guisubmenu>Profiles</guisubmenu>
                  <guimenuitem>Work</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>A profile for use at work</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul" >&Ctrl; <keycap>Q</keycap></keycombo></shortcut>
            <guimenu>File</guimenu>
            <guimenuitem>Quit</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Quit &smb4k;.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>
  
<!--
      Command Reference : The Network Menu
  -->

  <sect1 id="command_reference_network_menu">
    <title>The Network Menu</title>

    <variablelist>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycap>F5</keycap></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Scan the whole network neighborhood, the highlighted workgroup/domain or computer for new entries. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network scan is running.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Abort</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Abort any running process of the network neighborhood browser. This action is invisible by default and will only be visible instead of the <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem> action when a network scan is running.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>F</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Search</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the search tool bar in the network neighborhood browser.</para>
        </listitem>
      </varlistentry> 
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Network</guimenu>
            <guimenuitem>Add Bookmark</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Add a bookmark to the currently selected remote share. This action is disabled if no share is selected. Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Add Custom Settings</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the <link linkend="network_neighborhood_browser_defining_custom_settings">Custom Settings</link> editor. You can set several custom settings for the selected server or share. If a workgroup or no item is selected, this menu entry is disabled. Read the <link linkend="custom_settings_adding">Adding Custom Settings</link> section for more details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Open Mount Dialog</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for mounting shares "manually". This feature may be needed if &smb4k; cannot find a server from which you want to mount a certain shared resource.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Authentication</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the <link linkend="network_neighborhood_browser_authentication">authentication dialog</link>. You can provide the login and password for the selected server or share. If a workgroup or no item is selected, this action is disabled.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Preview</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para><link linkend="network_neighborhood_browser_previewing">Preview</link> the contents of the selected remote share. This action is only enabled if a share is selected. Printer shares cannot be previewed.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Print File</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para><link linkend="network_neighborhood_browser_printing">Print</link> a file on a remote printer. This action is only available if a printer share is selected.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Mount</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Mount the selected remote share. By default and if you clicked anything different than a share with type "Disk" or "IPC", this action is disabled. If you selected a mounted share, this action is replaced by the <guimenuitem>Unmount</guimenuitem> action.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut>
            <guimenu>Network</guimenu>
            <guimenuitem>Unmount</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Unmount the selected share. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action when the share is currently mounted.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>
  
<!--
      Command Reference : The Shares Menu
  -->

  <sect1 id="command_reference_shares_menu">
    <title>The Shares Menu</title>

    <variablelist>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Shares</guimenu>
            <guisubmenu>View Modes</guisubmenu>
          </menuchoice>
        </term>
        <listitem>
          <para>Choose the view mode from the submenu.</para>
          <variablelist>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>Shares</guimenu>
                  <guisubmenu>View Modes</guisubmenu>
                  <guimenuitem>Icon View</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>The shares are shown in an icon view.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>Shares</guimenu>
                  <guisubmenu>View Modes</guisubmenu>
                  <guimenuitem>List View</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>The shares are shown in a list view.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Unmount</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Unmount one or multiple selected shares. The ability to unmount shares is by default restricted to the ones that are owned by the user. However, you can change this behavior by changing the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog. If no share is selected in the shares view, this button is disabled.</para>
          <para>&smb4k; provides the ability to force unmounting of shares (&Linux; only). This can be useful for inaccessible shares that cannot be unmounted in the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog.</para>
          <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Unmount All</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Unmount all shares at once. The restrictions noted above also apply here. If you do not have any shares mounted, this button is disabled.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Shares</guimenu>
            <guimenuitem>Add Bookmark</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Add a bookmark to the currently selected mounted share. This action is disabled if no share is selected. Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Add Custom Settings</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the <link linkend="network_neighborhood_browser_defining_custom_settings">Custom Settings</link> editor. You can set several custom settings for the selected share. Read the <link linkend="custom_settings_adding">Adding Custom Settings</link> section for more details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>Y</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Synchronize</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Start the <link linkend="shares_view_synchronization">synchronization</link> of a share with a local copy or vice versa. This menu entry is only enabled if you installed the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and a share is selected.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>L</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Open with Konsole</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the base folder of the selected share in &konsole;.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>I</keycap></keycombo></shortcut>
            <guimenu>Shares</guimenu>
            <guimenuitem>Open with File Manager</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the contents of the selected share in the default file manager (&eg; &dolphin;).</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>
  
<!--
      Command Reference : The Bookmarks Menu
  -->

  <sect1 id="command_reference_bookmarks_menu">
    <title>The Bookmarks Menu</title>

    <variablelist>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Bookmarks</guimenu>
            <guimenuitem>Edit Bookmarks</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the <link linkend="bookmarks_editor">bookmark editor</link>. This action is disabled if there are no bookmarks.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut>
            <guimenu>Bookmarks</guimenu>
            <guimenuitem>Add Bookmark</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Add one or several bookmarks. At least one share has to be selected to enable this action.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Bookmarks</guimenu>
            <guimenuitem>Mount Bookmarks</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Mount all top level bookmarks at once. It is disabled if all bookmarked shares are mounted. This action is not present if there are no top level bookmarks.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>
  
<!--
      Command Reference : The Settings Menu
  -->

  <sect1 id="command_reference_settings_menu">
    <title>The Settings Menu</title>

    <variablelist>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Settings</guimenu>
            <guimenuitem>Toolbars Shown</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>In this submenu you can enable or disable the tool bars.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Settings</guimenu>
            <guimenuitem>Show Statusbar</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Hide or show the status bar.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Settings</guimenu>
            <guimenuitem>Dock Widgets</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Hide or show the dock widgets in the main window.</para>
          <variablelist>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>Settings</guimenu>
                  <guisubmenu>Dock Widgets</guisubmenu>
                  <guimenuitem>Network Neighborhood</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>Hide or show the <guilabel>Network Neighborhood</guilabel> dock widget.</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>
                <menuchoice>
                  <guimenu>Settings</guimenu>
                  <guisubmenu>Dock Widgets</guisubmenu>
                  <guimenuitem>Mounted Shares</guimenuitem>
                </menuchoice>
              </term>
              <listitem>
                <para>Hide or show the <guilabel>Mounted Shares</guilabel> dock widget.</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <menuchoice>
            <guimenu>Settings</guimenu>
            <guimenuitem>Configure &smb4k;...</guimenuitem>
          </menuchoice>
        </term>
        <listitem>
          <para>Open the configuration dialog.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect1>

<!--
      Command Reference : The Help Menu
  -->
  
  <sect1 id="command_reference_help_menu">
    <title>The Help Menu</title>

    <para>Additionally &smb4k; has the common &kde; <guimenu>Help</guimenu> menu items, for more information read the section about the <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.</para>
  </sect1>
</chapter>

<!-- 
      Reporting Bugs 
  -->

<chapter id="reporting_bugs">
  <title>Reporting Bugs</title>

  <para>Before filing a bug report, please try the <ulink url="https://sourceforge.net/projects/smb4k/files/">latest version</ulink> of &smb4k;. Maybe your problem has already been fixed.</para>
  <para>Follow these directions for your bug report:</para>
  <itemizedlist>
    <listitem><para>Describe <emphasis>in detail</emphasis> what you did to receive the problem you are reporting.</para></listitem>
    <listitem><para>Provide the version of &smb4k; and &kde-frameworks;.</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 <filename>README.md</filename> file shipped in the sources.</para></listitem>
    <listitem><para>Add additional data, &eg; 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 use the dialog that opens when you click the <menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice> menu item. But you can also go directly to the <ulink url="https://bugs.kde.org/enter_bug.cgi?product=Smb4k&amp;format=guided">KDE Bugtracking System</ulink> and fill out the form.</para>
</chapter>


<!-- 
      Credits and License 
  -->

<chapter id="credits" >
  <title>Credits and License</title>

  <para>Copyright &copy; 2003 - 2023, Alexander Reinholdt <email>alexander.reinholdt@kdemail.net</email></para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
  &underFDL;
  &underGPL;

  <simplesect>
    <title>Developers</title>
      
    <itemizedlist>
      <listitem><para>Alexander Reinholdt <email>alexander.reinholdt@kdemail.net</email></para></listitem>
    </itemizedlist>
  </simplesect>

  <simplesect>
    <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@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>


</book>
