Git commit 990aeccc70b63a612333bb31c5e5dad4297bdcb0 by Alexander Reinholdt. Committed on 24/03/2021 at 05:54. Pushed by areinholdt into branch 'master'.
Updated handbook. M +11 -13 doc/index.docbook M +- -- doc/synchronization_progress.png https://invent.kde.org/network/smb4k/commit/990aeccc70b63a612333bb31c5e5dad4297bdcb0 diff --git a/doc/index.docbook b/doc/index.docbook index 0566d511..8a32d879 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -546,7 +546,7 @@ </screenshot> <para>You can switch between the two views by selecting either the appropriate entry in the <guimenuitem>View Modes</guimenuitem> submenu from the <link linkend="mainwindow_overview"><guimenu>Shares View</guimenu></link> menu of the main window or in the shares view's <link linkend="shares_view_actions_popup_menu">popup menu</link>.</para> - <para>By default, only your own mounts are displayed. However, you can tell &smb4k; to show all mounts by altering the <link linkend="configuration_page_mounting_basic_settings_behavior">respective settings</link>.</para> + <para>By default, only your own mounts are displayed. However, you can adjust &smb4k; to show all mounts with the <link linkend="configuration_page_mounting_basic_settings_behavior">respective settings</link>.</para> </sect2> <!-- @@ -593,8 +593,7 @@ </menuchoice> </term> <listitem> - <para>Unmount one or multiple selected shares. The ability to unmount shares is by default restricted to the ones that are owned by you. 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>Unmount one or multiple selected shares. If no share is selected in the shares view, this button is disabled.</para> <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> </listitem> </varlistentry> @@ -606,7 +605,7 @@ </menuchoice> </term> <listitem> - <para>Unmount all shares at once. The restrictions noted above also apply here. If you do not have any shares mounted, this button is disabled.</para> + <para>Unmount all shares at once. If you do not have any shares mounted, this button is disabled.</para> <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> </listitem> </varlistentry> @@ -618,7 +617,7 @@ </menuchoice> </term> <listitem> - <para>Add a bookmark to the currently selected mounted shares. This action is disabled if no share is selected.</para> + <para>Add bookmarks to the currently selected mounted shares. This action is disabled if no share is selected.</para> <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para> </listitem> </varlistentry> @@ -630,7 +629,7 @@ </menuchoice> </term> <listitem> - <para>Start the <link linkend="shares_view_synchronization">synchronization</link> of a share with a local copy or vice versa. This menu entry is only enabled if you installed the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and a share is selected.</para> + <para><link linkend="shares_view_synchronization">Synchronize</link> a share with a local copy or vice versa. This menu entry is only enabled if you installed the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and a share is selected.</para> </listitem> </varlistentry> <varlistentry> @@ -679,7 +678,7 @@ <sect2 id="shares_view_tooltips"> <title>Tooltips</title> - <para>The tooltips provide information about the share name, the mount point, the user and group, the login, the file system, the disk usage, and the free disk space. If the share is <link linkend="shares_view_inaccessible_shares">inaccessible</link>, these values are marked as unknown.</para> + <para>The tooltips provide information about the remote location of the share, the mountpoint, the user and group, the login, the file system, the disk usage, and the free disk space. If the share is <link linkend="shares_view_inaccessible_shares">inaccessible</link>, these values are marked as unknown.</para> <para>Tooltips are enabled by default. You can deactivate them in the <link linkend="configuration_page_user_interface_shares_view">configuration dialog</link>.</para> </sect2> @@ -714,7 +713,7 @@ </mediaobject> </screenshot> <itemizedlist> - <listitem><para>The icon on the left hand side indicates that this share is not accessible. &smb4k; won't allow you to open it or synchronize it. You will only be able to unmount it or add a bookmark.</para></listitem> + <listitem><para>The icon on the left hand side indicates that this share is not accessible. &smb4k; won't allow you to open or synchronize it. You will only be able to unmount it or add a bookmark.</para></listitem> <listitem><para>The central icon indicates that the share is online, accessible, and owned by you. You may perform all available actions on it.</para></listitem> <listitem><para>All shares marked with a warning sign like the one on the right hand side are owned by another user. They are only shown if you adjusted the <link linkend="configuration_page_mounting_basic_settings_behavior">settings</link> to display them. In the default configuration, you are not allowed to unmount these shares, but you can <link linkend="configuration_page_mounting_basic_settings_behavior">change this behavior</link>, too.</para></listitem> </itemizedlist> @@ -763,7 +762,7 @@ </mediaobject> </screenshot> <para>If you click the <guibutton>Yes</guibutton> button, the share will definitely be unmounted. So, please think twice before you decide to unmount shares that are owned by other users!</para> - <para>Inaccessible shares are unmounted with a "normal" unmount by default. If this should fail, you can <link linkend="configuration_page_mounting_basic_settings_behavior">configure</link> &smb4k; so as to perform a <ulink url="man:/umount">lazy unmount</ulink> on inaccessible shares (&Linux; only).</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. &smb4k; will then perform a <ulink url="man:/umount">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> </sect2> @@ -787,7 +786,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 some details about the transfer.</para> + <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> <screenshot> <screeninfo>Screenshot of the synchronization progress dialog</screeninfo> <mediaobject> @@ -799,9 +798,8 @@ </textobject> </mediaobject> </screenshot> - <para>In the default, collapsed version it displays the source and destination of the file that is currently transferred, the transfer rate and the overall progress. More information like the number of transferred files and a graphical representation of the transfer rate can be seen by clicking the <guibutton>[+]</guibutton> (More) button on the left below to the progress bar.</para> - <para>The synchronization can be paused or canceled at any time by pressing the pause or stop button to the right of the progress bar.</para> - + <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. Their size is not considered. That means that one very large file adds to the progress as much as a very small one does. Also, due to the way <application>rsync</application> displays the transfer progress, the progress bar is only updated after the transfer of the file finished.</para> diff --git a/doc/synchronization_progress.png b/doc/synchronization_progress.png index 670ba604..c3b3cb6b 100644 Binary files a/doc/synchronization_progress.png and b/doc/synchronization_progress.png differ
