[smb4k] doc: Updated handbook.
Alexander Reinholdt
null at kde.org
Sun Jan 8 11:50:09 UTC 2017
Git commit e3fb6cdb56b83958c86a464531b03bf9781e1619 by Alexander Reinholdt.
Committed on 08/01/2017 at 11:14.
Pushed by areinholdt into branch 'master'.
Updated handbook.
A +- -- doc/configuration_page_profiles_migration_assistant.png
M +1983 -2143 doc/index.docbook
M +- -- doc/notification_share_mounted.png
D +- -- doc/profile_migration_assistant.png
M +- -- doc/systemsettings_manage_notifications.png
https://commits.kde.org/smb4k/e3fb6cdb56b83958c86a464531b03bf9781e1619
diff --git a/doc/configuration_page_profiles_migration_assistant.png b/doc/configuration_page_profiles_migration_assistant.png
new file mode 100644
index 0000000..7602cbf
Binary files /dev/null and b/doc/configuration_page_profiles_migration_assistant.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index d3c4d3d..95e763f 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1312,119 +1312,129 @@
Using Smb4K : Profiles
-->
-<sect1 id="profiles">
- <title>Profiles</title>
-
- <para>&smb4k; offers the use of different profiles. They are intended for better handling of different network neighborhoods, ⪚ if you are using your laptop at home and at work.</para>
- <para>By default, the use of different profiles is disabled and a default profile is used: one profile for everything. Most users won't have to change anything, because the default behavior satisfies their needs completely. However, for some users this feature might be very useful.</para>
+ <sect1 id="profiles">
+ <title>Profiles</title>
+
+ <para>&smb4k; offers the use of different profiles. They are intended for better handling of different network neighborhoods, ⪚ if you are using your laptop at home and at work.</para>
+ <para>By default, the use of different profiles is disabled and a default profile is used: one profile for everything. Most users won't have to change anything, because the default behavior satisfies their needs completely. However, for some users this feature might be very useful.</para>
-<!-- Using Smb4K : Profiles : Enabling and Managing Profiles -->
+<!--
+ 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_profiles">configuration dialog</link>. The first profile in the list, most likely the <guilabel>Home</guilabel> profile, is picked to be the active profile. You can also enable the profile migration assistant.</para>
- <para>Two profiles are pre-defined, <guilabel>Home</guilabel> and <guilabel>Work</guilabel>, but you can define as many profiles as you want. A new profile is added by entering its name into the edit line on the <guibutton>Profiles</guibutton> configuration page and clicking <guibutton>Add</guibutton> afterwards.</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>If you want to rename a profile, just click it and edit the name edit line. Clicking <guibutton>Add</guibutton> will update the name in the list view. All stored settings will be migrated seamlessly (without the use of the migration assistant). A profile can be removed by selecting it in the list view and clicking <guibutton>Remove</guibutton>. There is also the possibility to change the order of the profiles with the <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons.</para>
- <para>In case you enabled the use of the migration assistant, it is always launched when you remove a profile or when you enable/disable the use of profiles. It provides the possibility to migrate all relevant settings</para>
- <itemizedlist>
- <listitem><para>of a profile that is to be removed to another one</para></listitem>
- <listitem><para>of the default profile to a specific other profile</para></listitem>
- <listitem><para>of all profiles back to the default profile</para></listitem>
- </itemizedlist>
- <para>The following screenshot shows exemplarily the profile migration assistant after you enabled the use of profiles:</para>
- <screenshot>
- <screeninfo>Screenshot of the profile migration assistant</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="profile_migration_assistant.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Profile Migration Assistant</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
- <para>Under <guilabel>Old Profile</guilabel> the old profile (<guilabel><Default Profile></guilabel> in this case) is listed. Under <guilabel>New Profile</guilabel> you can choose the profile where the settings should be migrated to from a drop-down menu. Clicking the <guibutton>OK</guibutton> button migrates the settings, clicking <guibutton>Cancel</guibutton> cancels the action.</para>
- <note><para>In order to use the migration assistant when you enable the use of profiles the first time, you need to enable its use at the same time you enable the use of profiles.</para></note>
- </sect2>
+ <sect2 id="profiles_enable">
+ <title>Enabling and Managing Profiles</title>
+ <para>The use of different profiles can be enabled in the <link linkend="configuration_profiles">configuration dialog</link>. The first profile in the list, most likely the <guilabel>Home</guilabel> profile, is picked to be the active profile. You can also enable the profile migration assistant.</para>
+ <para>Two profiles are pre-defined, <guilabel>Home</guilabel> and <guilabel>Work</guilabel>, but you can define as many profiles as you want. A new profile is added by entering its name into the edit line on the <guibutton>Profiles</guibutton> configuration page and clicking <guibutton>Add</guibutton> afterwards.</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>If you want to rename a profile, just click it and edit the name edit line. Clicking <guibutton>Add</guibutton> will update the name in the list view. All stored settings will be migrated seamlessly (without the use of the migration assistant). A profile can be removed by selecting it in the list view and clicking <guibutton>Remove</guibutton>. There is also the possibility to change the order of the profiles with the <guibutton>Move Up</guibutton> and <guibutton>Move Down</guibutton> buttons.</para>
+ <para>In case you enabled the use of the migration assistant, it is always launched when you remove a profile or when you enable/disable the use of profiles. It provides the possibility to migrate all relevant settings</para>
+ <itemizedlist>
+ <listitem><para>of a profile that is to be removed to another one</para></listitem>
+ <listitem><para>of the default profile to a specific other profile</para></listitem>
+ <listitem><para>of all profiles back to the default profile</para></listitem>
+ </itemizedlist>
+ <para>The following screenshot shows exemplarily the profile migration assistant after you enabled the use of profiles:</para>
+ <screenshot>
+ <screeninfo>Screenshot of the profile migration assistant</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="configuration_page_profiles_migration_assistant.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Profile Migration Assistant</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>Under <guilabel>Old Profile</guilabel> the old profile (<guilabel><Default Profile></guilabel> in this case) is listed. Under <guilabel>New Profile</guilabel> you can choose the profile where the settings should be migrated to from a drop-down menu. Clicking the <guibutton>OK</guibutton> button migrates the settings, clicking <guibutton>Cancel</guibutton> cancels the action.</para>
+ <note><para>In order to use the migration assistant when you enable the use of profiles the first time, you need to enable its use at the same time you enable the use of profiles.</para></note>
+ </sect2>
-<!-- Using Smb4K : Profiles : Activating a Profile -->
+<!--
+ Using Smb4K : Profiles : Activating a Profile
+ -->
- <sect2 id="profiles_activate_profile">
- <title>Activating a Profile</title>
- <para>By default, the first profile in the list is set active when you enable the use of profiles. The active profile can be changed in the <guimenu>Profiles</guimenu> menu of the main window or the system tray widget or on the <guilabel>Profiles</guilabel> page of the plasmoid.</para>
- <para>When a profile is activated, several things happen:</para>
- <itemizedlist>
- <listitem><para>All currently mounted shares are unmounted and are scheduled for remount.</para></listitem>
- <listitem><para>All shares are remounted that were previously mounted under the activated profile.</para></listitem>
- <listitem><para>The bookmarks of this profile are loaded.</para></listitem>
- <listitem><para>The custom options of this profile are loaded.</para></listitem>
- </itemizedlist>
- <para>So, don't be surprised when things change when you selected a different profile ...</para>
- </sect2>
-</sect1>
+ <sect2 id="profiles_activate_profile">
+ <title>Activating a Profile</title>
+ <para>By default, the first profile in the list is set active when you enable the use of profiles. The active profile can be changed in the <guimenu>Profiles</guimenu> menu of the main window or the system tray widget or on the <guilabel>Profiles</guilabel> page of the plasmoid.</para>
+ <para>When a profile is activated, several things happen:</para>
+ <itemizedlist>
+ <listitem><para>All currently mounted shares are unmounted and are scheduled for remount.</para></listitem>
+ <listitem><para>All shares are remounted that were previously mounted under the activated profile.</para></listitem>
+ <listitem><para>The bookmarks of this profile are loaded.</para></listitem>
+ <listitem><para>The custom options of this profile are loaded.</para></listitem>
+ </itemizedlist>
+ <para>So, don't be surprised when things change when you selected a different profile ...</para>
+ </sect2>
+ </sect1>
-<!-- Using Smb4K : Notifications -->
+<!--
+ Using Smb4K : Notifications
+ -->
-<sect1 id="notifications">
- <title>Notifications</title>
+ <sect1 id="notifications">
+ <title>Notifications</title>
-<!-- Using Smb4K : Notifications : Default Behavior -->
+<!--
+ 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 also a sound is played. The screenshot below shows the notification that pops up after a share was 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>
+ <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 also a sound is played. The screenshot below shows the notification that pops up after a share was 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 -->
+<!--
+ Using Smb4K : Notifications : Managing Notifications
+ -->
- <sect2 id="notifications_manage">
- <title>Managing Notifications</title>
- <para>&smb4k; uses notifications to inform the user about events, warnings and errors. They can be managed via the &systemsettings;. To modify the behavior of one or all notifications, open the <guibutton>Application and System Notifications</guibutton> module and choose the <guibutton>Manage Notifications</guibutton> entry. In the tab <guilabel>Applications</guilabel> select the <guilabel>Advanced Network Neighborhood Browser</guilabel> entry from the drop-down menu:</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 available notifications are shown in the list view and can be edited, enabled and disabled according to your liking.</para>
- </sect2>
-</sect1>
+ <sect2 id="notifications_manage">
+ <title>Managing Notifications</title>
+ <para>&smb4k; uses notifications to inform the user about events, warnings and errors. They can be managed via the &systemsettings;. To modify the behavior of one or all notifications, open the <guibutton>Application and System Notifications</guibutton> module and choose the <guibutton>Manage Notifications</guibutton> entry. In the tab <guilabel>Applications</guilabel> select the <guilabel>Advanced Network Neighborhood Browser</guilabel> entry from the drop-down menu:</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 available notifications are shown in the list view and can be edited, enabled and disabled according to your liking.</para>
+ </sect2>
+ </sect1>
<!--
Using Smb4K : Special Remarks
-->
-<sect1 id="special_remarks">
- <title>Special Remarks</title>
+ <sect1 id="special_remarks">
+ <title>Special Remarks</title>
<!--
Using Smb4K : Special Remarks : Samba Security Fixes of April 12, 2016
-->
- <sect2 id="special_remarks_samba_security_updates">
- <title>Remarks Regarding the Samba Security Fixes of April 12, 2016</title>
-
- <para>On April 12, 2016 the Samba team released security fixes for the <ulink url="http://www.badlock.org">Badlock bug</ulink>. Unfortunately, they also introduced a regression that causes the <command>net</command> command to fail on many systems when querying remote hosts. If you experience this issue, you can add two lines to the [global] section of your <filename>smb.conf</filename> file to make browsing work again:</para>
+ <sect2 id="special_remarks_samba_security_updates">
+ <title>Remarks Regarding the Samba Security Fixes of April 12, 2016</title>
+
+ <para>On April 12, 2016 the Samba team released security fixes for the <ulink url="http://www.badlock.org">Badlock bug</ulink>. Unfortunately, they also introduced a regression that causes the <command>net</command> command to fail on many systems when querying remote hosts. If you experience this issue, you can add two lines to the [global] section of your <filename>smb.conf</filename> file to make browsing work again:</para>
<programlisting>[global]
...
@@ -1432,53 +1442,53 @@ client max protocol = SMB3
client ipc max protocol = NT1
...</programlisting>
- <para>Unfortunately, this fix for &smb4k; breaks the possibility to connect to the network neighborhood with &dolphin; and maybe also other programs.</para>
- </sect2>
+ <para>Unfortunately, this fix for &smb4k; breaks the possibility to connect to the network neighborhood with &dolphin; and maybe also other programs.</para>
+ </sect2>
<!--
Using Smb4K : Special Remarks : Remarks for FreeBSD Users
-->
- <sect2 id="special_remarks_freebsd">
- <title>Remarks for FreeBSD Users</title>
+ <sect2 id="special_remarks_freebsd">
+ <title>Remarks for FreeBSD Users</title>
- <sect3 id="special_remarks_freebsd_mounting">
- <title>Mounting of Shares (Smb4K >= 1.2.0)</title>
+ <sect3 id="special_remarks_freebsd_mounting">
+ <title>Mounting of Shares (Smb4K >= 1.2.0)</title>
- <para>Since version 1.2.0, the password for a share is directly passed to <command>mount_smbfs</command>, so that the <filename>~/.nsmbrc</filename> is not necessary anymore for mounting to work. Moreover, &smb4k; will not write any data to that file anymore.</para>
- </sect3>
- </sect2>
+ <para>Since version 1.2.0, the password for a share is directly passed to <command>mount_smbfs</command>, so that the <filename>~/.nsmbrc</filename> is not necessary anymore for mounting to work. Moreover, &smb4k; will not write any data to that file anymore.</para>
+ </sect3>
+ </sect2>
<!--
Using Smb4K : Special Remarks : Remarks for NetBSD Users
-->
- <sect2 id="special_remarks_netbsd">
- <title>Remarks for NetBSD Users</title>
-
- <sect3 id="special_remarks_netbsd_installation">
- <title>DBUS and PolicyKit</title>
-
- <para>Under NetBSD, &smb4k; is able to run since version 1.2.0. However, some modifications have to be made in order to be able to mount and unmount shares:</para>
- <para>Assuming that the prefix of your &kde; installation is <filename class="directory">/usr/pkg</filename>, the following steps have to be taken to make &smb4k; work properly:</para>
- <itemizedlist>
- <listitem><para>Configure, compile and install &smb4k; according to the directions given in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> section of the appendix.</para></listitem>
- <listitem><para>After installation, link (or copy) the file <filename>net.sourceforge.smb4k.mounthelper.conf</filename> from the <filename class="directory">examples</filename> directory to the right location:</para>
- <para><screen><userinput><prompt>$</prompt> <command>cd</command> <filename class="directory">/usr/pkg/etc/dbus-1/system.d/</filename></userinput>
- <userinput><prompt>$</prompt> <command>sudo ln</command> -s \
- <filename>/usr/pkg/share/examples/kde4-dbus/net.sourceforge.smb4k.mounthelper.conf</filename> .</userinput></screen></para></listitem>
- <listitem><para>Edit the file <filename>/usr/pkg/etc/PolicyKit/PolicyKit.conf</filename> and add the following paragraph in the <config version="0.1"> section:</para>
+ <sect2 id="special_remarks_netbsd">
+ <title>Remarks for NetBSD Users</title>
+
+ <sect3 id="special_remarks_netbsd_installation">
+ <title>DBUS and PolicyKit</title>
+
+ <para>Under NetBSD, &smb4k; is able to run since version 1.2.0. However, some modifications have to be made in order to be able to mount and unmount shares:</para>
+ <para>Assuming that the prefix of your &kde; installation is <filename class="directory">/usr/pkg</filename>, the following steps have to be taken to make &smb4k; work properly:</para>
+ <itemizedlist>
+ <listitem><para>Configure, compile and install &smb4k; according to the directions given in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> section of the appendix.</para></listitem>
+ <listitem><para>After installation, link (or copy) the file <filename>net.sourceforge.smb4k.mounthelper.conf</filename> from the <filename class="directory">examples</filename> directory to the right location:</para>
+ <para><screen><userinput><prompt>$</prompt> <command>cd</command> <filename class="directory">/usr/pkg/etc/dbus-1/system.d/</filename></userinput>
+ <userinput><prompt>$</prompt> <command>sudo ln</command> -s \
+ <filename>/usr/pkg/share/examples/kde4-dbus/net.sourceforge.smb4k.mounthelper.conf</filename> .</userinput></screen></para></listitem>
+ <listitem><para>Edit the file <filename>/usr/pkg/etc/PolicyKit/PolicyKit.conf</filename> and add the following paragraph in the <config version="0.1"> section:</para>
<programlisting>
<match action="org.kde.smb4k.mounthelper.*">
<return result="yes">
</match></programlisting>
- <para>This will allow everyone to mount and unmount remote Samba shares with &smb4k;.</para></listitem>
- </itemizedlist>
- </sect3>
- </sect2>
-</sect1>
+ <para>This will allow everyone to mount and unmount remote Samba shares with &smb4k;.</para></listitem>
+ </itemizedlist>
+ </sect3>
+ </sect2>
+ </sect1>
</chapter>
@@ -1487,2334 +1497,2164 @@ client ipc max protocol = NT1
-->
<chapter id="configuration">
-<title>Configuring &smb4k;</title>
-
-<para>This section describes the settings that are available to configure &smb4k;. To open the configuration dialog, you have to click the <link linkend="mainwindow_overview"><guimenuitem>Configure &smb4k;...</guimenuitem></link> menu item.</para>
-
-<!-- Configuring Smb4K : User Interface -->
-
-<sect1 id="configuration_user_interface">
-<title>User Interface</title>
-
-<para>With the options located here you can change the appearance and behavior of several dialogs and widgets. Please note that if you want to change the appearance of the main window you will find additional options under <guimenu>Settings</guimenu> in the <link linkend="mainwindow_overview">menubar</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 : Network Neighborhood -->
-
-<sect2 id="configuration_user_interface_network">
-<title>Network Neighborhood</title>
-
-<sect3 id="configuration_user_interface_network_behavior">
-<title>Behavior</title>
-<variablelist>
-<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>
-</variablelist>
-</sect3>
-
-<sect3 id="configuration_user_interface_network_columns">
-<title>Columns</title>
-<variablelist>
-<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>
-</variablelist>
-</sect3>
-
-<sect3 id="configuration_user_interface_network_tooltips">
-<title>Tooltips</title>
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show a tooltip with information about the network item</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>
-</sect3>
-</sect2>
-
-<!-- Configuring Smb4K : User Interface : Mounted Shares -->
-
-<sect2 id="configuration_user_interface_shares">
-<title>Mounted Shares</title>
-
-<sect3 id="configuration_user_interface_shares_view">
-<title>View</title>
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show mounted shares in an icon view</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-An icon view will be used to show the mounted shares.
-</para>
-<para>
-Default: selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show mounted shares in a list view</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-A list view will be used to show the mounted shares.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-<para>The following settings are specifically defined for the list view:</para>
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the owner and group</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the UID and GID that owns the share in the list view.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the login name</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the login name that was used for mounting. An entry will only be shown if the share was mounted with the CIFS file system. The column will be empty otherwise.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the file system</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the file system that is used by the share.
-</para>
-<para>
-Default: selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the free disk space</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the free disk space that is available on the share.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the used disk space</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the disk space that is in use on the share.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the total disk space</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the total disk space that the share offers.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the disk usage</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-Show the disk usage in percent.
-</para>
-<para>
-Default: selected
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="configuration_user_interface_shares_mounted_shares">
-<title>Mounted Shares</title>
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show the mount point instead of the share name</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-The mount point is shown instead of the share name.
-</para>
-<para>
-Default: not selected
-</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</sect3>
-
-<sect3 id="configuration_user_interface_shares_tooltips">
-<title>Tooltips</title>
-<variablelist>
-<varlistentry>
-<term>
-<menuchoice>
-<guibutton>Show a tooltip with information about the share</guibutton>
-</menuchoice>
-</term>
-<listitem>
-<para>
-A tooltip will be shown if you move the mouse pointer over an item in the shares view. It contains information about the underlying item 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>
-</sect3>
-</sect2>
-
-<!-- Configuring Smb4K : User Interface : Miscellaneous Settings -->
-
-<sect2 id="configuration_user_interface_misc">
-<title>Miscellaneous Settings</title>
-
-<sect3 id="configuration_user_interface_misc_bookmarks">
-<title>Bookmarks</title>
-<variablelist>
-<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>
-</sect3>
-</sect2>
-</sect1>
+ <title>Configuring &smb4k;</title>
+
+ <para>This section describes the settings that are available to configure &smb4k;. To open the configuration dialog, you have to click the <link linkend="mainwindow_overview"><guimenuitem>Configure &smb4k;...</guimenuitem></link> menu item.</para>
+
+<!--
+ Configuring Smb4K : User Interface
+ -->
+
+ <sect1 id="configuration_user_interface">
+ <title>User Interface</title>
+
+ <para>With the options located here you can change the appearance and behavior of several dialogs and widgets. Please note that if you want to change the appearance of the main window you will find additional options under <guimenu>Settings</guimenu> in the <link linkend="mainwindow_overview">menubar</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 : Network Neighborhood
+ -->
+
+ <sect2 id="configuration_user_interface_network">
+ <title>Network Neighborhood</title>
+
+ <sect3 id="configuration_user_interface_network_behavior">
+ <title>Behavior</title>
+
+ <variablelist>
+ <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>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_user_interface_network_columns">
+ <title>Columns</title>
+
+ <variablelist>
+ <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>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_user_interface_network_tooltips">
+ <title>Tooltips</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Show a tooltip with information about the network item</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>
+ </sect3>
+ </sect2>
+
+<!--
+ Configuring Smb4K : User Interface : Mounted Shares
+ -->
+
+ <sect2 id="configuration_user_interface_shares">
+ <title>Mounted Shares</title>
+
+ <sect3 id="configuration_user_interface_shares_view">
+ <title>View</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>View mode of the shares view</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><guibutton>Icon View</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The icon view mode</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>List View</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The list view mode</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>Default: <guibutton>Icon View</guibutton></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_user_interface_shares_tooltips">
+ <title>Tooltips</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Show a tooltip with information about the share</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>A tooltip will be shown if you move the mouse pointer over an item in the shares view. It contains information about the underlying item 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>
+ </sect3>
+ </sect2>
+
+<!--
+ Configuring Smb4K : User Interface : Miscellaneous Settings
+ -->
+
+ <sect2 id="configuration_user_interface_misc">
+ <title>Miscellaneous Settings</title>
+
+ <sect3 id="configuration_user_interface_misc_bookmarks">
+ <title>Bookmarks</title>
+
+ <variablelist>
+ <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>
+ </sect3>
+ </sect2>
+ </sect1>
<!--
Configuring Smb4K : Network
-->
-<sect1 id="configuration_network">
- <title>Network</title>
+ <sect1 id="configuration_network">
+ <title>Network</title>
- <para>The options located here can be used to change the lookup method for the browse list, to make &smb4k; send authentication information when querying the workgroup master browsers, to modify the behavior when previewing or looking up remote shares, and to enable periodic scanning as well as the Wake-On-LAN features. If you want to adjust the behavior of Samba programs, see the <link linkend="configuration_page_samba">Samba</link> section.</para>
+ <para>The options located here can be used to change the lookup method for the browse list, to make &smb4k; send authentication information when querying the workgroup master browsers, to modify the behavior when previewing or looking up remote shares, and to enable periodic scanning as well as the Wake-On-LAN features. If you want to adjust the behavior of Samba programs, see the <link linkend="configuration_page_samba">Samba</link> section.</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>
+ <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 : General Settings
-->
- <sect2 id="configuration_network_general">
- <title>General Settings</title>
+ <sect2 id="configuration_network_general">
+ <title>General Settings</title>
- <sect3 id="configuration_network_browselist">
+ <sect3 id="configuration_network_browselist">
<title>Browse List</title>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Scan the network neighborhood for available workgroups and domains</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>&smb4k; will search for all available master browsers on the network by using <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>. This is the default method and it is very reliable in finding all workgroups and domains of your network neighborhood. However, it suffers a few shortcomings like poor unicode support (⪚ umlauts might be replaced by dots).</para>
+ <para>Default: selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Query the current workgroup master browser</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The current master browser of your workgroup or domain is looked up and queried for the browse list. If some of the workgroup names of your network neighborhood contain umlauts or other special characters, you might want to try this method, since unicode is supported. However, sometimes outdated workgroup master browsers might be returned.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Query this custom master browser</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The master browser entered in the text box will be queried to retrieve the browse list. It can be specified by using either its NetBIOS name or its IP address. This option might be of use if you have an uncommonly configured network neighborhood.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>The <guibutton>Scan these broadcast areas</guibutton> method was removed prior to the release of &smb4k; 2.0.0, because it was buggy.</para>
+ </note>
+ </sect3>
+
+ <sect3 id="configuration_network_master_authentication">
+ <title>Authentication</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>The master browsers require authentication to return the browse list</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>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_network_general_behavior">
+ <title>Behavior</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Lookup method for IP addresses</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Define the method that is to be used to detect the IP addresses of the hosts. By default, <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is used.</para>
+ <para>The following options are available:</para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Use nmblookup command</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Use the <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Use net command</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Use the <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> command.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>Default: <guibutton>Use nmblookup command</guibutton></para>
+ </listitem>
+ </varlistentry>
+ <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, e.g. 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_network_advanced">
+ <title>Advanced Settings</title>
+
+ <sect3 id="configuration_network_periodic_scanning">
+ <title>Periodic Scanning</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Scan the network neighborhood periodically</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>If you want to enable periodic scanning of the network neighborhood, you need to check this button. With this method, all available network items are looked up, &ie; workgroups and domains, servers and shares.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Interval between scans</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>If periodic scanning is enabled, this is the time in minutes that elapses until a new scan is triggered.</para>
+ <para>Default: 5 min</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_network_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 the setting in this section. The hosts that should to be woken up have to be defined through the <link linkend="network_neighborhood_browser_defining_custom_options">custom options dialog</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 package 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Waiting time</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>This is the waiting time in seconds between the sending of the magic Wake-On-LAN packages and the scanning of the network neighborhood or the mounting of a share.</para>
+ <para>Default: 5 s</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+ </sect1>
+
+<!--
+ Configuring Smb4K : Shares
+-->
+
+ <sect1 id="conmfiguration_page_shares">
+ <title>Shares</title>
+
+ <para>These options determine where &smb4k; will mount the remote shares and how it behaves ⪚ on start-up and exit. If you want to configure the mount options, please see the <link linkend="configuration_page_samba">Samba</link> section.</para>
+
+ <screenshot>
+ <screeninfo>Screenshot of the "Shares" configuration tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="configuration_page_shares.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>The "Shares" configuration tab</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+
+<!--
+ Configuring Smb4K : Shares : Directories
+-->
+
+ <sect2 id="conmfiguration_page_shares_directories">
+ <title>Directories</title>
+
<variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Scan the network neighborhood for available workgroups and domains</guibutton></menuchoice>
- </term>
- <listitem>
- <para>&smb4k; will search for all available master browsers on the network by using <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>. This is the default method and it is very reliable in finding all workgroups and domains of your network neighborhood. However, it suffers a few shortcomings like poor unicode support (⪚ umlauts might be replaced by dots).</para>
- <para>Default: selected</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Query the current workgroup master browser</guibutton></menuchoice>
+ <menuchoice><guibutton>Mount prefix</guibutton></menuchoice>
</term>
<listitem>
- <para>The current master browser of your workgroup or domain is looked up and queried for the browse list. If some of the workgroup names of your network neighborhood contain umlauts or other special characters, you might want to try this method, since unicode is supported. However, sometimes outdated workgroup master browsers might be returned.</para>
- <para>Default: not selected</para>
+ <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>Query this custom master browser</guibutton></menuchoice>
+ <menuchoice><guibutton>Force generated subdirectories to be lower case</guibutton></menuchoice>
</term>
<listitem>
- <para>The master browser entered in the text box will be queried to retrieve the browse list. It can be specified by using either its NetBIOS name or its IP address. This option might be of use if you have an uncommonly configured network neighborhood.</para>
+ <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>
-
- <note>
- <para>The <guibutton>Scan these broadcast areas</guibutton> method was removed prior to the release of &smb4k; 2.0.0, because it was buggy.</para>
- </note>
- </sect3>
+ </sect2>
+
+<!--
+ Configuring Smb4K : Shares : Behavior
+-->
- <sect3 id="configuration_network_master_authentication">
- <title>Authentication</title>
+ <sect2 id="configuration_page_shares_behavior">
+ <title>Behavior</title>
<variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>The master browsers require authentication to return the browse list</guibutton></menuchoice>
+ <menuchoice><guibutton>Remount shares</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>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>
+ <note><para>This setting does not affect the automatic remounting of shares when your computer woke up from a sleep state.</para></note>
<para>Default: not selected</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="configuration_network_general_behavior">
- <title>Behavior</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Lookup method for IP addresses</guibutton></menuchoice>
+ <menuchoice><guilabel>Number of remount attempts</guilabel></menuchoice>
</term>
<listitem>
- <para>Define the method that is to be used to detect the IP addresses of the hosts. By default, <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> is used.</para>
- <para>The following options are available:</para>
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Use nmblookup command</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Use the <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Use net command</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Use the <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> command.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>Default: <guibutton>Use nmblookup command</guibutton></para>
+ <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><guibutton>Detect printer shares</guibutton></menuchoice>
+ <menuchoice><guilabel>Interval between remount attempts</guilabel></menuchoice>
</term>
<listitem>
- <para>Printer shares are detected.</para>
- <para>Default: selected</para>
+ <para>Set the time that elapses between attempts to remount shares.</para>
+ <para>Default: 5 min</para>
</listitem>
- </varlistentry>
+ </varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Detect hidden shares</guibutton></menuchoice>
+ <menuchoice><guibutton>Unmount all personal shares on exit</guibutton></menuchoice>
</term>
<listitem>
- <para>Hidden shares are detected. Hidden shares are ending with a $ sign, e.g. Musik$ or IPC$.</para>
- <para>Default: selected</para>
+ <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>
<varlistentry>
<term>
- <menuchoice><guibutton>Preview hidden files and directories</guibutton></menuchoice>
+ <menuchoice><guibutton>Force the unmounting of inaccessible shares</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>Force the 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>
- </variablelist>
- </sect3>
- </sect2>
-
-<!--
- Configuring Smb4K : Network : Advanced Settings
--->
-
- <sect2 id="configuration_network_advanced">
- <title>Advanced Settings</title>
-
- <sect3 id="configuration_network_periodic_scanning">
- <title>Periodic Scanning</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Scan the network neighborhood periodically</guibutton></menuchoice>
+ <menuchoice><guibutton>Allow the unmounting of shares that are owned by other users</guibutton></menuchoice>
</term>
<listitem>
- <para>If you want to enable periodic scanning of the network neighborhood, you need to check this button. With this method, all available network items are looked up, &ie; workgroups and domains, servers and shares.</para>
+ <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>Interval between scans</guibutton></menuchoice>
+ <menuchoice><guibutton>Detect all shares that are mounted on the system</guibutton></menuchoice>
</term>
<listitem>
- <para>If periodic scanning is enabled, this is the time in minutes that elapses until a new scan is triggered.</para>
- <para>Default: 5 min</para>
+ <para>You will not only see the shares that were mounted and are owned by you, but also all other mounts using the SMBFS (FreeBSD) and CIFS (&Linux;) file system that are present on the system.</para>
+ <para>Default: not selected</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>
- </sect3>
+ </sect2>
+ </sect1>
- <sect3 id="configuration_network_wake_on_lan">
- <title>Wake-On-LAN</title>
+<!--
+ Configuration: Authentication
+-->
- <para>To be able to use the Wake-On-LAN capability of &smb4k;, you have to enable the setting in this section. The hosts that should to be woken up have to be defined through the <link linkend="network_neighborhood_browser_defining_custom_options">custom options dialog</link>.</para>
+ <sect1 id="configuration_page_authentication">
+ <title>Authentication</title>
- <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 package 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Waiting time</guibutton></menuchoice>
- </term>
- <listitem>
- <para>This is the waiting time in seconds between the sending of the magic Wake-On-LAN packages and the scanning of the network neighborhood or the mounting of a share.</para>
- <para>Default: 5 s</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
- </sect2>
-</sect1>
+ <para>Here you can change the settings affecting the authentication.</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>
<!--
- Configuring Smb4K : Shares
+ Configuring Smb4K : Authentication : General Settings
-->
-<sect1 id="conmfiguration_page_shares">
- <title>Shares</title>
+ <sect2 id="configuration_page_authentication_general">
+ <title>General Settings</title>
+
+ <sect3 id="configuration_page_authentication_general_storage">
+ <title>Password Storage</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Save logins in a wallet</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The login names and passwords are stored in a subfolder named <filename role="directory">Smb4K</filename> of the current network wallet (default: "kdewallet"). The advantage of this method is, that the authentication data is stored permanently and encrypted on your hard drive. You only have to provide it once and the next time it is needed, &smb4k; will read it from the wallet. If you uncheck this option, the authentication data won't be stored at all.</para>
+ <para>Default: selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
- <para>These options determine where &smb4k; will mount the remote shares and how it behaves ⪚ on start-up and exit. If you want to configure the mount options, please see the <link linkend="configuration_page_samba">Samba</link> section.</para>
+ <sect3 id="configuration_page_authentication_general_default">
+ <title>Default Login</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Use a default login</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The default login is used by default to authenticate to the servers in your network neighborhood. If you enable this feature, a password dialog pops up, where you can provide the default login information.</para>
+ <screenshot>
+ <screeninfo>Screenshot of the default login input dialog</screeninfo>
+ <mediaobject>
+ <imageobject><imagedata fileref="dialog_default_login.png" format="PNG" /></imageobject>
+ <textobject><phrase>The default login input dialog</phrase></textobject>
+ </mediaobject>
+ </screenshot>
+ <para>You have to fill in at least the user name. Empty passwords are supported.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
- <screenshot>
- <screeninfo>Screenshot of the "Shares" configuration tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="configuration_page_shares.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The "Shares" configuration tab</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<!--
+ Configuring Smb4K : Authentication : Wallet Entries
+-->
+
+ <sect2 id="configuration_page_authentication_wallet_entries">
+ <title>Wallet Entries</title>
+
+ <para>The <guilabel>Wallet Entries</guilabel> tab contains an editor with that you can modify or remove existing wallet entries.</para>
+ <screenshot>
+ <screeninfo>Screenshot of the wallet entries editor</screeninfo>
+ <mediaobject>
+ <imageobject><imagedata fileref="configuration_page_authentication_wallet_entries.png" format="PNG" /></imageobject>
+ <textobject><phrase>The wallet entries editor</phrase></textobject>
+ </mediaobject>
+ </screenshot>
+ <para>Before you can edit the wallet entries, you have to load them from the wallet by pressing the <guibutton>Load</guibutton> button. The list of entries appears then on the left. An entry can be edited by selecting it and checking the <guibutton>Show details</guibutton> button. The details are then shown on the right and can be modified.</para>
+ <para>An entry can be removed by right clicking it and choosing the <guimenuitem>Remove</guimenuitem> item from the popup menu. All wallet entries may be removed at once by choosing the <guimenuitem>Clear List</guimenuitem> item.</para>
+ <para>Changes can be reset by choosing the <guimenuitem>Undo</guimenuitem> item from the popup menu either in the wallet entries list widget or in the details widget.</para>
+ <para>After you finished editing, the changes have to be committed to the wallet by pressing <guibutton>Save</guibutton>.</para>
+ </sect2>
+ </sect1>
<!--
- Configuring Smb4K : Shares : Directories
+ Configuring Smb4K : Samba
-->
- <sect2 id="conmfiguration_page_shares_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>
- </sect2>
+ <sect1 id="configuration_page_samba">
+ <title>Samba</title>
+
+ <para>Here you can directly influence the command line arguments that are passed to the Samba programs. Please note, that the settings will have no effect outside &smb4k; and that no changes will be applied to the <filename>smb.conf</filename> configuration file. For further information, please refer to the manual pages of the Samba software suite.</para>
+
+ <screenshot>
+ <screeninfo>Screenshot of the "Samba" configuration page</screeninfo>
+ <mediaobject>
+ <imageobject><imagedata fileref="configuration_page_samba.png" format="PNG" /></imageobject>
+ <textobject><phrase>The "Samba" configuration page</phrase></textobject>
+ </mediaobject>
+ </screenshot>
<!--
- Configuring Smb4K : Shares : Behavior
+ Configuring Smb4K : Samba : General Settings
-->
+
+ <sect2 id="configuration_page_samba_general">
+ <title>General Settings</title>
+
+ <sect3 id="configuration_page_samba_general_general">
+ <title>General Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>NetBIOS name</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the NetBIOS name of your computer. The text box should already be filled with the information found in the <filename>smb.conf</filename> configuration file or with the hostname of your computer. Under normal circumstances there is no need to change anything here.</para>
+ <para>Default: NetBIOS name defined in <filename>smb.conf</filename> or the hostname</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Domain</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the name of the domain/workgroup your computer is in. The text box should already be filled with the information found in the <filename>smb.conf</filename> configuration file. Under normal circumstances there is no need to change anything here.</para>
+ <para>Default: domain name defined in <filename>smb.conf</filename></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Socket options</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the TCP socket options. Please refer to the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> manual page to learn more.</para>
+ <para>Default: socket options defined in <filename>smb.conf</filename></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>NetBIOS scope</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the NetBIOS scope. It is recommended that you read the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> manual page before entering anything here.</para>
+ <para>Default: NetBIOS scope defined in <filename>smb.conf</filename></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>SMB port</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Sets the remote SMB port number that is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to communicate with a remote host. Under FreeBSD, 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>
+ </variablelist>
+ </sect3>
- <sect2 id="configuration_page_shares_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>
- <note><para>This setting does not affect the automatic remounting of shares when your computer woke up from a sleep state.</para></note>
- <para>Default: not selected</para>
- </listitem>
- </varlistentry>
- <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>
- <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 the unmounting of inaccessible shares</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Force the 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 (FreeBSD) and CIFS (&Linux;) file system that are present on the system.</para>
- <para>Default: not selected</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-</sect1>
+ <sect3 id="configuration_page_samba_general_authentication">
+ <title>Authentication</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Try to authenticate with Kerberos</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Use Kerberos for authentication in an Active Directory environment. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Authenticate with local machine account</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Make queries to the remote server using the machine account of the local server. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</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. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="configuration_page_samba_general_security">
+ <title>Security</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Signing state</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the client signing state. This setting is used by <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
+ <para>The following options are available:</para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>None</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Do not set the client signing state.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>On</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the client signing state to <emphasis>on</emphasis>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Off</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the client signing state to <emphasis>off</emphasis>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Required</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Set the client signing state to <emphasis>required</emphasis>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>Default: None</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Encrypt SMB transport</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>This option requires the remote server to support the &UNIX; extensions. Request that the connection be encrypted. This is new for Samba 3.2 and will only work with Samba 3.2 or above servers. Fails the connection if encryption cannot be negotiated.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
<!--
- Configuration: Authentication
+ Configuring Smb4K : Samba : Utility Programs
-->
-<sect1 id="configuration_page_authentication">
- <title>Authentication</title>
+ <sect2 id="configuration_page_samba_utility_programs">
+ <title>Utility Programs</title>
+
+ <sect3 id="configuration_page_samba_utility_programs_nmblookup">
+ <title>nmblookup</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Broadcast address</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Send a query to the given broadcast address. Without this option the default behavior of nmblookup is to send the query to the broadcast address of the network interfaces as either auto-detected or defined in the <programlisting>interfaces = ...</programlisting> parameter of the <filename>smb.conf</filename> file.</para>
+ <para>Default: options defined in <filename>smb.conf</filename></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Try and bind to UDP port 137 to send and receive UDP datagrams</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to UDP port 137. Under normal circumstances, you do not need to tick this check box. If you experience problems while scanning the network and you want to enable this option, read the manual page of <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> before.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
- <para>Here you can change the settings affecting the authentication.</para>
+ <sect3 id="configuration_page_samba_utility_programs_smbclient">
+ <title>smbclient</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Name resolve order</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Determine what naming services and in what order are used to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. The options are: "lmhost", "host", "wins" and "bcast". For further information see the manual page of <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
+ <para>Default: options defined in <filename>smb.conf</filename></para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Buffer size</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Change the transmit/send buffer size when getting or putting a file from/to a remote server.</para>
+ <para>Default: 65520 Bytes</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
- <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>
+ <sect3 id="configuration_page_samba_utility_programs_smbtree">
+ <title>smbtree</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Send requests as broadcasts</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Query network nodes by sending requests as broadcasts instead of querying the local master browser.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+ </sect2>
+ </sect1>
<!--
- Configuring Smb4K : Authentication : General Settings
+ Configuring Smb4K : Mounting
-->
- <sect2 id="configuration_page_authentication_general">
- <title>General Settings</title>
-
- <sect3 id="configuration_page_authentication_general_storage">
- <title>Password Storage</title>
+ <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 : Common Options
+-->
+
+ <sect2 id="configuration_page_mounting_common">
+ <title>Common Options</title>
+
<variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Save logins in a wallet</guibutton></menuchoice>
+ <menuchoice><guibutton>User ID</guibutton></menuchoice>
</term>
<listitem>
- <para>The login names and passwords are stored in a subfolder named <filename role="directory">Smb4K</filename> of the current network wallet (default: "kdewallet"). The advantage of this method is, that the authentication data is stored permanently and encrypted on your hard drive. You only have to provide it once and the next time it is needed, &smb4k; will read it from the wallet. If you uncheck this option, the authentication data won't be stored at all.</para>
- <para>Default: selected</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>Default: your UID</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="configuration_page_authentication_general_default">
- <title>Default Login</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Use a default login</guibutton></menuchoice>
+ <menuchoice><guibutton>Group ID</guibutton></menuchoice>
</term>
<listitem>
- <para>The default login is used by default to authenticate to the servers in your network neighborhood. If you enable this feature, a password dialog pops up, where you can provide the default login information.</para>
- <screenshot>
- <screeninfo>Screenshot of the default login input dialog</screeninfo>
- <mediaobject>
- <imageobject><imagedata fileref="dialog_default_login.png" format="PNG" /></imageobject>
- <textobject><phrase>The default login input dialog</phrase></textobject>
- </mediaobject>
- </screenshot>
- <para>You have to fill in at least the user name. Empty passwords are supported.</para>
- <para>Default: not selected</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>Default: your GID</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>File mask</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 mask (fmask), you should read the <ulink url="man:/mount"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
+ <para>Default: 0755</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- </sect2>
-
-<!--
- Configuring Smb4K : Authentication : Wallet Entries
--->
-
- <sect2 id="configuration_page_authentication_wallet_entries">
- <title>Wallet Entries</title>
-
- <para>The <guilabel>Wallet Entries</guilabel> tab contains an editor with that you can modify or remove existing wallet entries.</para>
- <screenshot>
- <screeninfo>Screenshot of the wallet entries editor</screeninfo>
- <mediaobject>
- <imageobject><imagedata fileref="configuration_page_authentication_wallet_entries.png" format="PNG" /></imageobject>
- <textobject><phrase>The wallet entries editor</phrase></textobject>
- </mediaobject>
- </screenshot>
- <para>Before you can edit the wallet entries, you have to load them from the wallet by pressing the <guibutton>Load</guibutton> button. The list of entries appears then on the left. An entry can be edited by selecting it and checking the <guibutton>Show details</guibutton> button. The details are then shown on the right and can be modified.</para>
- <para>An entry can be removed by right clicking it and choosing the <guimenuitem>Remove</guimenuitem> item from the popup menu. All wallet entries may be removed at once by choosing the <guimenuitem>Clear List</guimenuitem> item.</para>
- <para>Changes can be reset by choosing the <guimenuitem>Undo</guimenuitem> item from the popup menu either in the wallet entries list widget or in the details widget.</para>
- <para>After you finished editing, the changes have to be committed to the wallet by pressing <guibutton>Save</guibutton>.</para>
- </sect2>
-</sect1>
-
-<!--
- Configuring Smb4K : Samba
--->
-
-<sect1 id="configuration_page_samba">
- <title>Samba</title>
-
- <para>Here you can directly influence the command line arguments that are passed to the Samba programs. Please note, that the settings will have no effect outside &smb4k; and that no changes will be applied to the <filename>smb.conf</filename> configuration file. For further information, please refer to the manual pages of the Samba software suite.</para>
-
- <screenshot>
- <screeninfo>Screenshot of the "Samba" configuration page</screeninfo>
- <mediaobject>
- <imageobject><imagedata fileref="configuration_page_samba.png" format="PNG" /></imageobject>
- <textobject><phrase>The "Samba" configuration page</phrase></textobject>
- </mediaobject>
- </screenshot>
-
-<!--
- Configuring Smb4K : Samba : General Settings
--->
-
- <sect2 id="configuration_page_samba_general">
- <title>General Settings</title>
-
- <sect3 id="configuration_page_samba_general_general">
- <title>General Options</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>NetBIOS name</guibutton></menuchoice>
+ <menuchoice><guibutton>Directory mask</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the NetBIOS name of your computer. The text box should already be filled with the information found in the <filename>smb.conf</filename> configuration file or with the hostname of your computer. Under normal circumstances there is no need to change anything here.</para>
- <para>Default: NetBIOS name defined in <filename>smb.conf</filename> or the hostname</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 folder mask (dmask), you should read the <ulink url="man:/mount"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
+ <para>Default: 0755</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Domain</guibutton></menuchoice>
+ <menuchoice><guibutton>Write access</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the name of the domain/workgroup your computer is in. The text box should already be filled with the information found in the <filename>smb.conf</filename> configuration file. Under normal circumstances there is no need to change anything here.</para>
- <para>Default: domain name defined in <filename>smb.conf</filename></para>
+ <para>Here you can determine if the shares should be mounted <emphasis>read-write</emphasis> or <emphasis>read-only</emphasis> by default. This option is independent of the file mask and the folder mask settings above.</para>
+ <para>Default: read-write</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Socket options</guibutton></menuchoice>
+ <menuchoice><guibutton>Client character set</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the TCP socket options. Please refer to the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> manual page to learn more.</para>
- <para>Default: socket options defined in <filename>smb.conf</filename></para>
+ <para>Sets the character set used by the client side (&ie; your computer).</para>
+ <para>Default: default</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>NetBIOS scope</guibutton></menuchoice>
+ <menuchoice><guibutton>Server codepage</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the NetBIOS scope. It is recommended that you read the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> manual page before entering anything here.</para>
- <para>Default: NetBIOS scope defined in <filename>smb.conf</filename></para>
+ <para>Sets the codepage the remote server uses.</para>
+ <para>This option is only available under FreeBSD.</para>
+ <para>Default: default</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>SMB port</guibutton></menuchoice>
+ <menuchoice><guibutton>File system port</guibutton></menuchoice>
</term>
<listitem>
- <para>Sets the remote SMB port number that is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> to communicate with a remote host. Under FreeBSD, 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>
+ <para>Sets the file system 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="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog to define individual port numbers for the problematic hosts.</para>
+ <para>This option is only available under &Linux;. Under FreeBSD, the port for mounting shares is set with the <guibutton>SMB port</guibutton> option.</para>
+ <para>Default: 445</para>
</listitem>
</varlistentry>
</variablelist>
- </sect3>
-
- <sect3 id="configuration_page_samba_general_authentication">
- <title>Authentication</title>
+ </sect2>
+
+<!--
+ Configuring Smb4K : Mounting : Advanced Options
+-->
+ <sect2 id="configuration_page_mounting_advanced">
+ <title>Advanced Options</title>
+
+ <para><emphasis>(This widget is not available under FreeBSD and NetBSD.)</emphasis></para>
+ <para>Most of the options you can define here require &Linux; kernel 2.6.15 or later to work.</para>
<variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Try to authenticate with Kerberos</guibutton></menuchoice>
+ <menuchoice><guibutton>Definitely assign the UID</guibutton></menuchoice>
</term>
<listitem>
- <para>Use Kerberos for authentication in an Active Directory environment. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</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>Authenticate with local machine account</guibutton></menuchoice>
+ <menuchoice><guibutton>Definitely assign the GID</guibutton></menuchoice>
</term>
<listitem>
- <para>Make queries to the remote server using the machine account of the local server. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</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>Use Winbind ccache for authentication</guibutton></menuchoice>
+ <menuchoice><guibutton>Do permission checks</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <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 might want to switch this feature off, if the server(s) support the CIFS Unix extensions and you are, hence, not allowed to access the share.</para>
+ <para>Default: selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Attempt to set UID and GID</guibutton></menuchoice>
</term>
<listitem>
- <para>Try to use the credentials cached by Winbind. This setting is used by <ulink url="man:/net"><citerefentry><refentrytitle>net</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</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>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: not selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Translate reserved characters</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <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 use locking</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Do not use locking. Do not start lockd.</para>
<para>Default: not selected</para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="configuration_page_samba_general_security">
- <title>Security</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Signing state</guibutton></menuchoice>
+ <menuchoice><guibutton>SMB protocol version</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the client signing state. This setting is used by <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
- <para>The following options are available:</para>
+ <para>Define which version of the SMB protocol is to be used.</para>
+ <para>The following values are allowed:</para>
<variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>None</guibutton></menuchoice>
+ <menuchoice><guibutton>1.0 (Classic CIFS/SMBv1 protocol)</guibutton></menuchoice>
</term>
<listitem>
- <para>Do not set the client signing state.</para>
+ <para>The <option>vers=1.0</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 the classic CIFS/SMBv1 protocol.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>On</guibutton></menuchoice>
+ <menuchoice><guibutton>2.0 (Windows Vista SP1/Windows Server 2008)</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the client signing state to <emphasis>on</emphasis>.</para>
+ <para>The <option>vers=2.0</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 the SMBv2.002 protocol. This was initially introduced in Windows Vista Service Pack 1, and Windows Server 2008.</para>
+ <note>
+ <para>Note that the initial release version of Windows Vista spoke a slightly different dialect (2.000) that is not supported.</para>
+ </note>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Off</guibutton></menuchoice>
+ <menuchoice><guibutton>2.1 (Windows 7/Windows Server 2008R2)</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the client signing state to <emphasis>off</emphasis>.</para>
+ <para>The <option>vers=2.1</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 the SMBv2.1 protocol that was introduced in Microsoft Windows 7 and Windows Server 2008R2.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Required</guibutton></menuchoice>
+ <menuchoice><guibutton>3.0 (Windows 8/Windows Server 2012)</guibutton></menuchoice>
</term>
<listitem>
- <para>Set the client signing state to <emphasis>required</emphasis>.</para>
+ <para>The <option>vers=3.0</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 the SMBv3.0 protocol that was introduced in Microsoft Windows 8 and Windows Server 2012.</para>
</listitem>
</varlistentry>
</variablelist>
- <para>Default: None</para>
+ <para>Default: <guibutton>1.0 (Classic CIFS/SMBv1 protocol)</guibutton></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Encrypt SMB transport</guibutton></menuchoice>
+ <menuchoice><guibutton>Cache mode</guibutton></menuchoice>
</term>
<listitem>
- <para>This option requires the remote server to support the &UNIX; extensions. Request that the connection be encrypted. This is new for Samba 3.2 and will only work with Samba 3.2 or above servers. Fails the connection if encryption cannot be negotiated.</para>
- <para>Default: not selected</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>The <option>cache=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 not cache file data at all.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Follow the CIFS/SMB2 protocol strictly</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>The <option>cache=strict</option> command line argument is used. 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>The <option>cache=loose</option> command line argument is used. 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: <guibutton>Follow the CIFS/SMB2 protocol strictly</guibutton></para>
</listitem>
</varlistentry>
- </variablelist>
- </sect3>
- </sect2>
-
-<!--
- Configuring Smb4K : Samba : Utility Programs
--->
-
- <sect2 id="configuration_page_samba_utility_programs">
- <title>Utility Programs</title>
-
- <sect3 id="configuration_page_samba_utility_programs_nmblookup">
- <title>nmblookup</title>
-
- <variablelist>
<varlistentry>
<term>
- <menuchoice><guibutton>Broadcast address</guibutton></menuchoice>
+ <menuchoice><guibutton>Security mode</guibutton></menuchoice>
</term>
<listitem>
- <para>Send a query to the given broadcast address. Without this option the default behavior of nmblookup is to send the query to the broadcast address of the network interfaces as either auto-detected or defined in the <programlisting>interfaces = ...</programlisting> parameter of the <filename>smb.conf</filename> file.</para>
- <para>Default: options defined in <filename>smb.conf</filename></para>
+ <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: <guibutton>NTLMSSP protocol</guibutton></para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <menuchoice><guibutton>Try and bind to UDP port 137 to send and receive UDP datagrams</guibutton></menuchoice>
+ <menuchoice><guibutton>Additional options</guibutton></menuchoice>
</term>
<listitem>
- <para>The reason for this option is a bug in Windows 95 where it ignores the source port of the requesting packet and only replies to UDP port 137. Under normal circumstances, you do not need to tick this check box. If you experience problems while scanning the network and you want to enable this option, read the manual page of <ulink url="man:/nmblookup"><citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> before.</para>
- <para>Default: not selected</para>
+ <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: empty</para>
</listitem>
</varlistentry>
</variablelist>
- </sect3>
-
- <sect3 id="configuration_page_samba_utility_programs_smbclient">
- <title>smbclient</title>
-
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Name resolve order</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Determine what naming services and in what order are used to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options. The options are: "lmhost", "host", "wins" and "bcast". For further information see the manual page of <ulink url="man:/smbclient"><citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink>.</para>
- <para>Default: options defined in <filename>smb.conf</filename></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Buffer size</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Change the transmit/send buffer size when getting or putting a file from/to a remote server.</para>
- <para>Default: 65520 Bytes</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="configuration_page_samba_utility_programs_smbtree">
- <title>smbtree</title>
-
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Send requests as broadcasts</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Query network nodes by sending requests as broadcasts instead of querying the local master browser.</para>
- <para>Default: not selected</para>
- </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 : Common Options
--->
-
- <sect2 id="configuration_page_mounting_common">
- <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 mask</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 mask (fmask), you should read the <ulink url="man:/mount"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
- <para>Default: 0755</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Directory mask</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 folder mask (dmask), you should read the <ulink url="man:/mount"><citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> and <ulink url="man:/umask"><citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry></ulink> manual pages.</para>
- <para>Default: 0755</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Write access</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Here you can determine if the shares should be mounted <emphasis>read-write</emphasis> or <emphasis>read-only</emphasis> by default. This option is independent of the file mask and the folder mask settings above.</para>
- <para>Default: read-write</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Client character set</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Sets the character set used by the client side (&ie; your computer).</para>
- <para>Default: default</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Server codepage</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Sets the codepage the remote server uses.</para>
- <para>This option is only available under FreeBSD.</para>
- <para>Default: default</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>File system port</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Sets the file system 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="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog to define individual port numbers for the problematic hosts.</para>
- <para>This option is only available under &Linux;. Under FreeBSD, the port for mounting shares is set with the <guibutton>SMB port</guibutton> option.</para>
- <para>Default: 445</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
-<!--
- Configuring Smb4K : Mounting : Advanced Options
--->
-
- <sect2 id="configuration_page_mounting_advanced">
- <title>Advanced Options</title>
-
- <para><emphasis>(This widget is not available under FreeBSD and NetBSD.)</emphasis></para>
- <para>Most of the options you can define here require &Linux; kernel 2.6.15 or later to work.</para>
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Definitely assign the UID</guibutton></menuchoice>
- </term>
- <listitem>
- <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>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>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 might want to switch this feature off, if the server(s) support the CIFS Unix extensions and you are, hence, not allowed to access the share.</para>
- <para>Default: selected</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Attempt to set UID and GID</guibutton></menuchoice>
- </term>
- <listitem>
- <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>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: not selected</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Translate reserved characters</guibutton></menuchoice>
- </term>
- <listitem>
- <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 use locking</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Do not use locking. Do not start lockd.</para>
- <para>Default: not selected</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>SMB protocol version</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Define which version of the SMB protocol is to be used.</para>
- <para>The following values are allowed:</para>
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>1.0 (Classic CIFS/SMBv1 protocol)</guibutton></menuchoice>
- </term>
- <listitem>
- <para>The <option>vers=1.0</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 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>The <option>vers=2.0</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 the SMBv2.002 protocol. This was initially introduced in Windows Vista Service Pack 1, and Windows Server 2008.</para>
- <note>
- <para>Note that the initial release version of Windows Vista spoke a slightly different dialect (2.000) that is not supported.</para>
- </note>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>2.1 (Windows 7/Windows Server 2008R2)</guibutton></menuchoice>
- </term>
- <listitem>
- <para>The <option>vers=2.1</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 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>The <option>vers=3.0</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 the SMBv3.0 protocol that was introduced in Microsoft Windows 8 and Windows Server 2012.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>Default: <guibutton>1.0 (Classic CIFS/SMBv1 protocol)</guibutton></para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Cache mode</guibutton></menuchoice>
- </term>
- <listitem>
- <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>The <option>cache=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 not cache file data at all.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Follow the CIFS/SMB2 protocol strictly</guibutton></menuchoice>
- </term>
- <listitem>
- <para>The <option>cache=strict</option> command line argument is used. 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>The <option>cache=loose</option> command line argument is used. 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: <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: <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: empty</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-</sect1>
+ </sect2>
+ </sect1>
<!--
Configuring Smb4K : Synchronization
-->
-<sect1 id="configuration_page_synchronization">
- <title>Synchronization</title>
+ <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>
+ <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>
+ <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 : Copying
-->
- <sect2 id="configuration_page_synchronization_copying">
- <title>Copying</title>
-
- <sect3 id="configuration_page_synchronization_copying_defdest">
- <title>Default Destination</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_synchronization_copying_general">
- <title>General</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>-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, because finding multiply-linked files is expensive. You must separately specify <option>-H</option>.</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: selected</para>
- </listitem>
- </varlistentry>
- <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: 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>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 (⪚ ".", "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>
- <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>
- </variablelist>
- </sect3>
-
- <sect3 id="configuration_page_synchronization_copying_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: 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>Only 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>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>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>
-
- <sect3 id="configuration_page_synchronization_copying_perms">
- <title>File Permissions, &etc;</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: 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: selected</para>
- </listitem>
- </varlistentry>
- <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: 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: 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: 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>
- </sect2>
-
-<!--
- Configuring Smb4K : Synchronization : File Deletion & Transfer
--->
-
- <sect2 id="configuration_page_synchronization_filedel">
- <title>File Deletion & Transfer</title>
-
- <sect3 id="configuration_page_synchronization_filedel_filedel">
- <title>File Deletion</title>
+ <sect2 id="configuration_page_synchronization_copying">
+ <title>Copying</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 (⪚ "<filename class="directory">dir</filename>" or "<filename class="directory">dir/</filename>") without using a wildcard for the folders contents (⪚ "<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>Also 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>
+ <sect3 id="configuration_page_synchronization_copying_defdest">
+ <title>Default Destination</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>
- <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>
+ <sect3 id="configuration_page_synchronization_copying_general">
+ <title>General</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>-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, because finding multiply-linked files is expensive. You must separately specify <option>-H</option>.</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: selected</para>
+ </listitem>
+ </varlistentry>
+ <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: 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>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 (⪚ ".", "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>
+ <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>
+ </variablelist>
+ </sect3>
- <sect3 id="configuration_page_synchronization_filedel_transfer">
- <title>File Transfer</title>
+ <sect3 id="configuration_page_synchronization_copying_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: 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>Only 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>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>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>
- <variablelist>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Do not transfer any file smaller than</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Option: <option>--min-size=NUM</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; NUM: 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=NUM</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; NUM: 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>
- </sect2>
+ <sect3 id="configuration_page_synchronization_copying_perms">
+ <title>File Permissions, &etc;</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: 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: selected</para>
+ </listitem>
+ </varlistentry>
+ <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: 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: 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: 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>
+ </sect2>
<!--
- Configuring Smb4K : Synchronization : Filtering
+ Configuring Smb4K : Synchronization : File Deletion & Transfer
-->
- <sect2 id="configuration_page_synchronization_filter">
- <title>Filtering</title>
-
- <sect3 id="configuration_page_synchronization_filter_general">
- <title>General</title>
+ <sect2 id="configuration_page_synchronization_filedel">
+ <title>File Deletion & Transfer</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>Do not exclude 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_filedel_filedel">
+ <title>File Deletion</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 (⪚ "<filename class="directory">dir</filename>" or "<filename class="directory">dir/</filename>") without using a wildcard for the folders contents (⪚ "<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>Also 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_filter_rules">
- <title>Filter Rules</title>
+ <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>
- <variablelist>
- <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: empty</para>
- </listitem>
- </varlistentry>
- <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>
- </variablelist>
- </sect3>
- </sect2>
+ <sect3 id="configuration_page_synchronization_filedel_transfer">
+ <title>File Transfer</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Do not transfer any file smaller than</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Option: <option>--min-size=NUM</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; NUM: 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=NUM</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; NUM: 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>
+ </sect2>
<!--
- Configuring Smb4K : Synchronization : Advanced Settings
+ Configuring Smb4K : Synchronization : Filtering
-->
- <sect2 id="configuration_page_synchronization_advanced">
- <title>Advanced Settings</title>
+ <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>Do not exclude 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_advanced_general">
- <title>General</title>
+ <sect3 id="configuration_page_synchronization_filter_rules">
+ <title>Filter Rules</title>
+
+ <variablelist>
+ <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: empty</para>
+ </listitem>
+ </varlistentry>
+ <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>
+ </variablelist>
+ </sect3>
+ </sect2>
- <variablelist>
- <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>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>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>
- <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>
+<!--
+ Configuring Smb4K : Synchronization : Advanced Settings
+-->
- <sect3 id="configuration_page_synchronization_advanced_backup">
- <title>Backup</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 (⪚ <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 (⪚, 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 rsync 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 id="configuration_page_synchronization_advanced">
+ <title>Advanced Settings</title>
+
+ <sect3 id="configuration_page_synchronization_advanced_general">
+ <title>General</title>
+
+ <variablelist>
+ <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>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>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>
+ <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>
- <sect3 id="configuration_page_synchronization_advanced_checksums">
- <title>Checksums</title>
+ <sect3 id="configuration_page_synchronization_advanced_backup">
+ <title>Backup</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 (⪚ <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 (⪚, 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 rsync 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>
- <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>
- </sect2>
-</sect1>
+ <sect3 id="configuration_page_synchronization_advanced_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>
+ </sect2>
+ </sect1>
<!--
Configuring Smb4K : Custom Options
-->
-<sect1 id="configuration_page_custom_options">
- <title>Custom Options</title>
+ <sect1 id="configuration_page_custom_options">
+ <title>Custom Options</title>
- <para>All servers and shares for which you defined custom options are listed here.</para>
+ <para>All servers and shares for which you defined custom options are listed here.</para>
- <screenshot>
- <screeninfo>Screenshot of the "Custom Options" configuration tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="configuration_page_custom_options.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The "Custom Options" configuration tab</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ <screenshot>
+ <screeninfo>Screenshot of the "Custom Options" configuration tab</screeninfo>
+ <mediaobject>
+ <imageobject><imagedata fileref="configuration_page_custom_options.png" format="PNG" /></imageobject>
+ <textobject><phrase>The "Custom Options" configuration tab</phrase></textobject>
+ </mediaobject>
+ </screenshot>
- <para>The options defined for a network item can be edited by either double clicking an entry in the list view or by choosing the <guimenuitem>Edit</guimenuitem> item from the popup menu (right click on the selected item). The custom options are then being loaded and can be edited. To remove an entry, right click it and choose the <guimenuitem>Remove</guimenuitem> item from the popup menu. All network items may be removed at once by choosing the <guimenuitem>Clear List</guimenuitem> item. Changes can be reset by choosing the <guimenuitem>Undo</guimenuitem> item from the popup menu.</para>
+ <para>The options defined for a network item can be edited by either double clicking an entry in the list view or by choosing the <guimenuitem>Edit</guimenuitem> item from the popup menu (right click on the selected item). The custom options are then being loaded and can be edited. To remove an entry, right click it and choose the <guimenuitem>Remove</guimenuitem> item from the popup menu. All network items may be removed at once by choosing the <guimenuitem>Clear List</guimenuitem> item. Changes can be reset by choosing the <guimenuitem>Undo</guimenuitem> item from the popup menu.</para>
- <para>The custom options are accessible through the editor widgets on the right. In the <guilabel>General</guilabel> section the UNC address of the network item and its editable IP address are shown. In case of a share, you can also define whether it should always be remounted. Below, the custom options are arranged in two tabs:</para>
+ <para>The custom options are accessible through the editor widgets on the right. In the <guilabel>General</guilabel> section the UNC address of the network item and its editable IP address are shown. In case of a share, you can also define whether it should always be remounted. Below, the custom options are arranged in two tabs:</para>
<!--
Configuring Smb4K : Custom Options : Samba
-->
- <sect2 id="configuration_page_custom_options_samba">
- <title>Samba</title>
-
- <para>You can edit various Samba settings here. Which ones are available depends on the operating system you are using. For more information, have a look at the description of the <link linkend="configuration_page_samba">Samba</link> configuration page.</para>
- </sect2>
+ <sect2 id="configuration_page_custom_options_samba">
+ <title>Samba</title>
+
+ <para>You can edit various Samba settings here. Which ones are available depends on the operating system you are using. For more information, have a look at the description of the <link linkend="configuration_page_samba">Samba</link> configuration page.</para>
+ </sect2>
<!--
Configuring Smb4K : Custom Options : Wake-On-LAN
-->
- <sect2 id="configuration_page_custom_options_wol">
- <title>Wake-On-LAN</title>
-
- <para>Here you can edit the options that you previously defined through the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog.</para>
- </sect2>
-</sect1>
+ <sect2 id="configuration_page_custom_options_wol">
+ <title>Wake-On-LAN</title>
+
+ <para>Here you can edit the options that you previously defined through the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog.</para>
+ </sect2>
+ </sect1>
<!--
Configuring Smb4K : Profiles
-->
-<sect1 id="configuration_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>
+ <sect1 id="configuration_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_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 options for each profile. This is especially useful if you are using a laptop in different network neighborhoods, ⪚ at home and at work. When enabling this setting the first time, the first entry in the <link linkend="configuration_profiles_profiles">profiles list</link> will be the active profile.</para>
- <para>Default: not selected</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice><guibutton>Use profile migration assistant</guibutton></menuchoice>
- </term>
- <listitem>
- <para>Use the profile migration assistant when profiles are removed or the use of profiles is enabled or disabled. The profile migration assistant allows you to migrate all settings that were saved for a certain profile to a different one.</para>
- <para>Default: not selected</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
+ <sect2 id="configuration_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 options for each profile. This is especially useful if you are using a laptop in different network neighborhoods, ⪚ at home and at work. When enabling this setting the first time, the first entry in the <link linkend="configuration_profiles_profiles">profiles list</link> will be the active profile.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <menuchoice><guibutton>Use profile migration assistant</guibutton></menuchoice>
+ </term>
+ <listitem>
+ <para>Use the profile migration assistant when profiles are removed or the use of profiles is enabled or disabled. The profile migration assistant allows you to migrate all settings that were saved for a certain profile to a different one.</para>
+ <para>Default: not selected</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
-<!-- Configuring Smb4K : Profiles : Profiles -->
+<!--
+ Configuring Smb4K : Profiles : Profiles
+ -->
- <sect2 id="configuration_profiles_profiles">
- <title>Profiles</title>
+ <sect2 id="configuration_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>), but you can add your own ones. When you enabled the use of profiles the first time, the first entry in the list will be the active profile.</para>
- <para>When you rename a profile, the settings are migrated automatically (without showing the migration assistant). If you enabled the use of the migration assistant, it is shown when you remove a profile giving you the opportunity to migrate the stored settings to another profile. If the use of the migration assistant is disabled, the profile and all of its settings are removed.</para>
- </sect2>
-</sect1>
+ <para>Here, you can manage your profiles. By default, there are two pre-defined ones (<guilabel>Home</guilabel> and <guilabel>Work</guilabel>), but you can add your own ones. When you enabled the use of profiles the first time, the first entry in the list will be the active profile.</para>
+ <para>When you rename a profile, the settings are migrated automatically (without showing the migration assistant). If you enabled the use of the migration assistant, it is shown when you remove a profile giving you the opportunity to migrate the stored settings to another profile. If the use of the migration assistant is disabled, the profile and all of its settings are removed.</para>
+ </sect2>
+ </sect1>
</chapter>
-<!-- Reporting bugs -->
+<!--
+ Reporting Bugs
+ -->
<chapter id="reporting_bugs">
-<title>Reporting Bugs</title>
-
-<para>Before filing a bug report, please read our <ulink url="https://sourceforge.net/p/smb4k/wiki/Home/">wiki</ulink>. Many common problems are already covered there. Also, 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;.</para></listitem>
-<listitem><para>Mention your operating system (&Linux;, FreeBSD, &etc;) and the distribution that is running on your computer.</para></listitem>
-<listitem><para>Include the full error message if an error dialog was displayed.</para></listitem>
-<listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> chapter in the appendix.</para></listitem>
-<listitem><para>Add additional data, ⪚ send a screen shot if you are reporting a &GUI; related problem.</para></listitem>
-</itemizedlist>
-<para>The recommended method to report a bug is to 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&format=guided">KDE Bugtracking System</ulink> and fill out the form.</para>
+ <title>Reporting Bugs</title>
+
+ <para>Before filing a bug report, please read our <ulink url="https://sourceforge.net/p/smb4k/wiki/Home/">wiki</ulink>. Many common problems are already covered there. Also, 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;.</para></listitem>
+ <listitem><para>Mention your operating system (&Linux;, FreeBSD, &etc;) and the distribution that is running on your computer.</para></listitem>
+ <listitem><para>Include the full error message if an error dialog was displayed.</para></listitem>
+ <listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> chapter in the appendix.</para></listitem>
+ <listitem><para>Add additional data, ⪚ send a screen shot if you are reporting a &GUI; related problem.</para></listitem>
+ </itemizedlist>
+ <para>The recommended method to report a bug is to 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&format=guided">KDE Bugtracking System</ulink> and fill out the form.</para>
</chapter>
-<!-- Credits and License -->
+<!--
+ Credits and License
+ -->
<chapter id="credits" >
-<title>Credits and License</title>
+ <title>Credits and License</title>
-<para>Copyright © 2003 - 2016, Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para>
+ <para>Copyright © 2003 - 2016, Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
-&underFDL;
-&underGPL;
+ &underFDL;
+ &underGPL;
-<simplesect>
- <title>Developers</title>
- <itemizedlist>
- <listitem><para>Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para></listitem>
- </itemizedlist>
-</simplesect>
+ <simplesect>
+ <title>Developers</title>
+
+ <itemizedlist>
+ <listitem><para>Alexander Reinholdt <email>alexander.reinholdt at kdemail.net</email></para></listitem>
+ </itemizedlist>
+ </simplesect>
-<simplesect>
- <title>Translations</title>
- <para>Translations were contributed by the &kde; translators.</para>
-</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 at sentry.granch.ru</email>, who convinced us to port &smb4k; to FreeBSD and helped us a great deal to achieve this goal.</para>
-</simplesect>
+ <simplesect>
+ <title>Special Thanks</title>
+
+ <para>The &smb4k; team would like to thank everyone who contributed by sending patches. Also, a big "Thank you!" goes to Rashid N. Achilov <email>shelton at sentry.granch.ru</email>, who convinced us to port &smb4k; to FreeBSD and helped us a great deal to achieve this goal.</para>
+ </simplesect>
</chapter>
-<!-- Appendix -->
+<!--
+ Appendix
+ -->
<appendix id="appendix">
<title>Appendix</title>
-<sect1 id="appendix_getting_smb4k" >
-<title>How to obtain &smb4k;</title>
-<para>The latest stable release is available at <ulink url="http://sourceforge.net/projects/smb4k/files/">http://sourceforge.net/projects/smb4k/files/</ulink>.</para>
-</sect1>
-
-<sect1 id="appendix_requirements" >
-<title>Requirements</title>
-
-<para>&smb4k; officially supports &Linux;, FreeBSD and NetBSD. Other operating systems might work as well, but haven't been tested.</para>
-<para>To compile &smb4k;, you need:</para>
-<itemizedlist>
- <listitem><para><ulink url="http://www.cmake.org">CMake</ulink> (≥ 3.3)</para></listitem>
- <listitem><para><ulink url="http://gcc.gnu.org">GNU Compiler Collection</ulink> (g++ ≥ 4.0) or <ulink url="http://clang.llvm.org">clang/LLVM</ulink> (≥ 3.0)</para></listitem>
-</itemizedlist>
-<para>&smb4k; depends on the following <ulink url="http://www.qt.io">&Qt;</ulink> (≥ 5.4.0) and <ulink url="http://www.kde.org">&kf5;</ulink> (≥ 5.9.0) modules:</para>
-<itemizedlist>
- <listitem><para>QtCore, QtGui, QtWidgets, QtTest, QtNetwork, QtPrintSupport, QtQml</para></listitem>
- <listitem><para>KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, KJobWidgets, KWallet, KDBusAddons, KParts, KConfigWidgets, KNotifications, KWindowSystem</para></listitem>
-</itemizedlist>
-<para>For a proper operation, you also need:</para>
-<itemizedlist>
- <listitem><para><ulink url="http://www.samba.org">Samba</ulink> (3.x or 4.x, 4.x recommended)</para></listitem>
-</itemizedlist>
-<para>To enable full functionality, you may also want to install these programs:</para>
-<itemizedlist>
- <listitem><para><ulink url="http://rsync.samba.org">rsync</ulink></para></listitem>
-</itemizedlist>
-<para>The list of changes can be found in the <filename>ChangeLog</filename> file.</para>
-</sect1>
-
-<!-- Appendix: Configuration, Compilation and Installation -->
-
-<sect1 id="appendix_compilation">
-<title>Configuration, Compilation and Installation</title>
-
-<para>This section describes the configuration, compilation and installation of &smb4k;. Make sure, you have read the <link linkend="appendix_requirements">Requirements</link> page before you start.</para>
-<para><ulink url="https://sourceforge.net/projects/smb4k/files">Download</ulink> the version of Smb4K you are interested in and extract the source tarball:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput>
- </screen>
-</para>
-<para>Replace x.y.z with the version number. Change into the source code directory and create a <filename class="directory">build</filename> directory:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">smb4k-x.y.z</filename></userinput>
- <prompt>$</prompt> <userinput><command>mkdir</command> <filename class="directory">build</filename></userinput>
- </screen>
-</para>
-<para>Change into the <filename class="directory">build</filename> directory and configure the source code:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
- <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
- </screen>
-</para>
-<para>If Smb4K cannot find some shared libraries after the installation (⪚ if you are using Kubuntu 16.04), it is necessary to add the <option>-DKDE_INSTALL_PLUGINDIR</option> argument to the command line above:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
- <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
- -DKDE_INSTALL_PLUGINDIR=`qtpaths --plugin-dir` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
- </screen>
-</para>
-<para>If you want to compile Smb4K with debug symbols, replace Release by Debug. You should consider this if you experience &ie; a crash and want to either debug &smb4k; yourself or report a bug including a full backtrace</para>
-<para>There are also some &smb4k; specific arguments you might be interested in:</para>
-<para>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Argument</entry>
- <entry>Since</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>-DINSTALL_HEADER_FILES=yes|no</entry>
- <entry align="center">1.0.0</entry>
- <entry>Install the core header files. This is off by default.</entry>
- </row>
- <row>
- <entry>-DINSTALL_PLASMOID=yes|no</entry>
- <entry align="center">1.1.0</entry>
- <entry>Install the plasmoid. KDE SC 4.10 or higher is required. This is on by default, if the right KDE version is detected.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-</para>
-<para>After the configuration, compile and install &smb4k;:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput>
- </screen>
-</para>
-<para>If you want to be able to remove &smb4k; with your package manager later on, use <application>checkinstall</application> instead of <command>make install</command>. The package should be present in your distribution's repository. Run:</para>
-<para>
- <screen>
- <prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput>
- </screen>
-</para>
-</sect1>
+ <sect1 id="appendix_getting_smb4k" >
+ <title>How to obtain &smb4k;</title>
+
+ <para>The latest stable release is available at <ulink url="http://sourceforge.net/projects/smb4k/files/">http://sourceforge.net/projects/smb4k/files/</ulink>.</para>
+ </sect1>
+
+ <sect1 id="appendix_requirements" >
+ <title>Requirements</title>
+
+ <para>&smb4k; officially supports &Linux;, FreeBSD and NetBSD. Other operating systems might work as well, but haven't been tested.</para>
+ <para>To compile &smb4k;, you need:</para>
+ <itemizedlist>
+ <listitem><para><ulink url="http://www.cmake.org">CMake</ulink> (≥ 3.3)</para></listitem>
+ <listitem><para><ulink url="http://gcc.gnu.org">GNU Compiler Collection</ulink> (g++ ≥ 4.0) or <ulink url="http://clang.llvm.org">clang/LLVM</ulink> (≥ 3.0)</para></listitem>
+ </itemizedlist>
+ <para>&smb4k; depends on the following <ulink url="http://www.qt.io">&Qt;</ulink> (≥ 5.4.0) and <ulink url="http://www.kde.org">&kf5;</ulink> (≥ 5.9.0) modules:</para>
+ <itemizedlist>
+ <listitem><para>QtCore, QtGui, QtWidgets, QtTest, QtNetwork, QtPrintSupport, QtQml</para></listitem>
+ <listitem><para>KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, Solid, KIO, KNotifications, KXmlGui, KJobWidgets, KWallet, KDBusAddons, KParts, KConfigWidgets, KNotifications, KWindowSystem</para></listitem>
+ </itemizedlist>
+ <para>For a proper operation, you also need:</para>
+ <itemizedlist>
+ <listitem><para><ulink url="http://www.samba.org">Samba</ulink> (3.x or 4.x, 4.x recommended)</para></listitem>
+ </itemizedlist>
+ <para>To enable full functionality, you may also want to install these programs:</para>
+ <itemizedlist>
+ <listitem><para><ulink url="http://rsync.samba.org">rsync</ulink></para></listitem>
+ </itemizedlist>
+ <para>The list of changes can be found in the <filename>ChangeLog</filename> file.</para>
+ </sect1>
+
+<!--
+ Appendix: Configuration, Compilation and Installation
+ -->
+
+ <sect1 id="appendix_compilation">
+ <title>Configuration, Compilation and Installation</title>
+
+ <para>This section describes the configuration, compilation and installation of &smb4k;. Make sure, you have read the <link linkend="appendix_requirements">Requirements</link> page before you start.</para>
+ <para><ulink url="https://sourceforge.net/projects/smb4k/files">Download</ulink> the version of Smb4K you are interested in and extract the source tarball:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput>
+ </screen>
+ </para>
+ <para>Replace x.y.z with the version number. Change into the source code directory and create a <filename class="directory">build</filename> directory:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">smb4k-x.y.z</filename></userinput>
+ <prompt>$</prompt> <userinput><command>mkdir</command> <filename class="directory">build</filename></userinput>
+ </screen>
+ </para>
+ <para>Change into the <filename class="directory">build</filename> directory and configure the source code:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
+ <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
+ </screen>
+ </para>
+ <para>If Smb4K cannot find some shared libraries after the installation (⪚ if you are using Kubuntu 16.04), it is necessary to add the <option>-DKDE_INSTALL_PLUGINDIR</option> argument to the command line above:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
+ <prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
+ -DKDE_INSTALL_PLUGINDIR=`qtpaths --plugin-dir` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
+ </screen>
+ </para>
+ <para>If you want to compile Smb4K with debug symbols, replace Release by Debug. You should consider this if you experience &ie; a crash and want to either debug &smb4k; yourself or report a bug including a full backtrace</para>
+ <para>There are also some &smb4k; specific arguments you might be interested in:</para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry>Argument</entry>
+ <entry>Since</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>-DINSTALL_HEADER_FILES=yes|no</entry>
+ <entry align="center">1.0.0</entry>
+ <entry>Install the core header files. This is off by default.</entry>
+ </row>
+ <row>
+ <entry>-DINSTALL_PLASMOID=yes|no</entry>
+ <entry align="center">1.1.0</entry>
+ <entry>Install the plasmoid. KDE SC 4.10 or higher is required. This is on by default, if the right KDE version is detected.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ <para>After the configuration, compile and install &smb4k;:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput>
+ </screen>
+ </para>
+ <para>If you want to be able to remove &smb4k; with your package manager later on, use <application>checkinstall</application> instead of <command>make install</command>. The package should be present in your distribution's repository. Run:</para>
+ <para>
+ <screen>
+ <prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput>
+ </screen>
+ </para>
+ </sect1>
</appendix>
-</book>
+</book>
\ No newline at end of file
diff --git a/doc/notification_share_mounted.png b/doc/notification_share_mounted.png
index ef3032a..3dd1647 100644
Binary files a/doc/notification_share_mounted.png and b/doc/notification_share_mounted.png differ
diff --git a/doc/profile_migration_assistant.png b/doc/profile_migration_assistant.png
deleted file mode 100644
index 7bec364..0000000
Binary files a/doc/profile_migration_assistant.png and /dev/null differ
diff --git a/doc/systemsettings_manage_notifications.png b/doc/systemsettings_manage_notifications.png
index 6e26558..317e66b 100644
Binary files a/doc/systemsettings_manage_notifications.png and b/doc/systemsettings_manage_notifications.png differ
More information about the kde-doc-english
mailing list