Git commit 8c7a5c3fb30b1296e51d47b6950f0e9379b82889 by Alexander Reinholdt. Committed on 09/12/2022 at 05:05. Pushed by areinholdt into branch 'master'.
Updated handbook. M +8 -13 doc/index.docbook M +- -- doc/shares_view_drop_popup_menu.png M +- -- doc/shares_view_synchronization_input_dialog.png https://invent.kde.org/network/smb4k/commit/8c7a5c3fb30b1296e51d47b6950f0e9379b82889 diff --git a/doc/index.docbook b/doc/index.docbook index 629333d1..a3be01da 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -744,9 +744,9 @@ <title>Unmounting Shares</title> <para>One or multiple selected shares may be unmounted by either clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> action, or by pressing its keyboard shortcut. By default, the ability to unmount a share is restricted to the ones that are owned by you. This behavior can be altered in the <link linkend="configuration_page_mounting_basic_settings_behavior">configuration dialog</link>. If you enabled the unmounting of shares that are owned by other users, you will be presented with a warning dialog prior to the actual unmount. If you proceed, the share will definitely be unmounted. So, please think twice before you decide to unmount those shares!</para> - <para>&smb4k; provides the ability to force the unmounting of shares (&Linux; only). This might be useful with inaccessible shares that cannot be unmounted the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog. &smb4k; will then perform a <ulink url="man:/umount(8)">lazy unmount</ulink> on inaccessible shares.</para> + <para>&smb4k; provides the ability to force unmounting of shares (&Linux; only). This can be useful with inaccessible shares that cannot in be unmounted the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog. &smb4k; will then perform a <ulink url="man:/umount(8)">lazy unmount</ulink> on inaccessible shares.</para> <para>All shares can be unmounted at once by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut><guimenuitem>Unmount All</guimenuitem></menuchoice> action. Depending on your settings, this will also unmount foreign and inaccessible shares.</para> - <para>After a successful unmount process, the user is notified. If unmounting fails, a notification with the returned error message will be shown.</para> + <para>After a successful unmount process, the user is notified. If unmounting fails, a notification with the returned error message is shown.</para> </sect2> <!-- @@ -756,7 +756,7 @@ <sect2 id="shares_view_synchronization"> <title>Synchronization</title> - <para>The <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo></shortcut><guimenuitem>Synchronize</guimenuitem></menuchoice> menu item opens the synchronization dialog. It offers you the mount point of the share as the source and a path below the <link linkend="configuration_page_synchronization_basic_settings_default_destination">synchronization prefix</link> as the destination. To update the data on the share, you can swap the destination with the source by clicking the <guibutton>Swap Paths</guibutton> button.</para> + <para>The <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo></shortcut><guimenuitem>Synchronize</guimenuitem></menuchoice> menu item opens the synchronization dialog. It offers the mount point of the share as the source and a path below the <link linkend="configuration_page_synchronization_basic_settings_default_destination">synchronization prefix</link> as the destination. To update the data on the share, you can swap the destination with the source by clicking the <guibutton>Swap Paths</guibutton> button.</para> <screenshot> <screeninfo>Screenshot of the synchronization input dialog</screeninfo> <mediaobject> @@ -768,7 +768,7 @@ </textobject> </mediaobject> </screenshot> - <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization. By left clicking on the <guibutton>Notifications</guibutton> button in the system tray, a progress dialog can be opened that shows details about the transfer.</para> + <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization and a progress dialog is shown that shows details about the transfer.</para> <screenshot> <screeninfo>Screenshot of the synchronization progress dialog</screeninfo> <mediaobject> @@ -781,11 +781,6 @@ </mediaobject> </screenshot> <para>The synchronization can be canceled at any time by pressing the stop button to the right of the progress bar.</para> - - <note> - <para>The total number of files that is shown in the progress dialog corresponds to the number of files present on the share and not necessarily to the total number of files that will actually be transferred.</para> - <para>The progress is calculated from the number of transferred files devided by the total number of files present on the share. File sizes are not considered. That means that one very large file adds to the progress just as much as a very small one does. Also, because of the way <application>rsync</application> displays the transfer progress, the progress bar is only updated after the transfer of another file finishes.</para> - </note> </sect2> <!-- @@ -2044,10 +2039,10 @@ ntlm auth = yes </varlistentry> <varlistentry> <term> - <menuchoice><guibutton>Force the unmounting of inaccessible shares</guibutton></menuchoice> + <menuchoice><guibutton>Force 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>Force unmounting of inaccessible shares (&Linux; only). In case a share is inaccessible, a lazy unmount is performed. Before the actual unmounting is done, a warning dialog is shown asking to approve the unmount.</para> <para>Default: not selected</para> </listitem> </varlistentry> @@ -4424,8 +4419,8 @@ ntlm auth = yes </term> <listitem> <para>Unmount one or multiple selected shares. The ability to unmount shares is by default restricted to the ones that are owned by the user. However, you can change this behavior by changing the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog. If no share is selected in the shares view, this button is disabled.</para> - <para>&smb4k; also provides the ability to force the unmounting of shares (&Linux; only). This might be useful with inaccessible shares that cannot be unmounted the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog.</para> - <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> + <para>&smb4k; provides the ability to force unmounting of shares (&Linux; only). This can be useful for inaccessible shares that cannot be unmounted in the normal way. To enable this feature, you need to modify the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> in the configuration dialog.</para> + <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> </listitem> </varlistentry> <varlistentry> diff --git a/doc/shares_view_drop_popup_menu.png b/doc/shares_view_drop_popup_menu.png index 04b7b91f..cee62961 100644 Binary files a/doc/shares_view_drop_popup_menu.png and b/doc/shares_view_drop_popup_menu.png differ diff --git a/doc/shares_view_synchronization_input_dialog.png b/doc/shares_view_synchronization_input_dialog.png index 3197dc97..b48d04a8 100644 Binary files a/doc/shares_view_synchronization_input_dialog.png and b/doc/shares_view_synchronization_input_dialog.png differ
