Git commit 30d77499615aa7e0b0a66b27eae9d12c831467cd by Alexander Reinholdt. Committed on 04/11/2016 at 05:40. Pushed by areinholdt into branch 'master'.
Merge branch 'master' of git.kde.org:smb4k M +2 -2 doc/index.docbook http://commits.kde.org/smb4k/30d77499615aa7e0b0a66b27eae9d12c831467cd diff --cc doc/index.docbook index 9534ace,35354f4..b082bfe --- a/doc/index.docbook +++ b/doc/index.docbook @@@ -801,92 -801,83 +801,92 @@@ </mediaobject> </screenshot> <para>To avoid the popup menu, press the &Shift; key for moving, the &Ctrl; key for copying and the <keycombo>&Ctrl;&Shift;</keycombo> key combination for linking while dragging and dropping. The transfer will only be successful if the share was mounted with read and write permissions.</para> - <para>You can also drag and drop the whole share to the desktop or to another application (⪚ dolphin;). Again, a popup menu will open asking you, what you want to do. When choosing the appropriate operation, please remember that under most circumstances moving and linking the share might not be a good idea.</para> + <para>You can also drag and drop the whole share to the desktop or to another application (⪚ &dolphin;). Again, a popup menu will open asking you, what you want to do. When choosing the appropriate operation, please remember that under most circumstances moving and linking the share might not be a good idea.</para> </sect2> -<!-- Using Smb4K : The Mounted Shares View : Unmounting Shares --> +<!-- + Using Smb4K : The Mounted Shares View : Unmounting Shares +--> -<sect2 id="mainwindow_shares_unmounting"> -<title>Unmounting Shares</title> -<para>One or multiple selected shares may be unmounted by either clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> action or by pressing its keyboard shortcut. By default, the ability to unmount a share is restricted to the ones that are owned by you. This behavior can be altered in the <link linkend="conmfiguration_page_shares">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:</para> -<screenshot> - <screeninfo>Screenshot of the warning dialog that is shown when a foreign share is to be unmounted</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="dialog_warning_unmount_foreign_share.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The warning dialog that is shown when unmounting foreign shares</phrase> - </textobject> - </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="conmfiguration_page_shares_behavior">configure</link> &smb4k; so as to perform a <ulink url="man:/umount">lazy unmount</ulink> on inaccessible shares (&Linux; only).</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> + <sect2 id="shares_view_unmounting"> + <title>Unmounting Shares</title> -<!-- Using Smb4K : The Mounted Shares View : Synchronization --> + <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="conmfiguration_page_shares_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:</para> + <screenshot> + <screeninfo>Screenshot of the warning dialog that is shown when a foreign share is to be unmounted</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog_warning_unmount_foreign_share.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The warning dialog that is shown when unmounting foreign shares</phrase> + </textobject> + </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="conmfiguration_page_shares_behavior">configure</link> &smb4k; so as to perform a <ulink url="man:/umount">lazy unmount</ulink> on inaccessible shares (&Linux; only).</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> -<sect2 id="mainwindow_shares_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 source and a path below the <link linkend="configuration_page_synchronization_copying_defdest">synchronization prefix</link> as destination. To update the data on the share, you can swap the destination with the source by clicking the <guibutton>Swap Paths</guibutton> button.</para> -<screenshot> -<screeninfo>Screenshot of the synchronization input dialog</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="dialog_synchronization_input.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>&URL; requester for sync'ing</phrase> -</textobject> -</mediaobject> -</screenshot> -<para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization. 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> -<screenshot> - <screeninfo>Screenshot of the synchronization progress dialog</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="dialog_synchronization_progress.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Progress dialog</phrase> - </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> +<!-- + Using Smb4K : The Mounted Shares View : Synchronization +--> -<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.</para> -</note> -</sect2> + <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 source and a path below the <link linkend="configuration_page_synchronization_copying_defdest">synchronization prefix</link> as destination. To update the data on the share, you can swap the destination with the source by clicking the <guibutton>Swap Paths</guibutton> button.</para> + <screenshot> + <screeninfo>Screenshot of the synchronization input dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog_synchronization_input.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>&URL; requester for sync'ing</phrase> + </textobject> + </mediaobject> + </screenshot> + <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization. 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> + <screenshot> + <screeninfo>Screenshot of the synchronization progress dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dialog_synchronization_progress.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Progress dialog</phrase> + </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> -<!-- Using Smb4K : The Mounted Shares View : Opening a Share --> + <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.</para> + </note> + </sect2> -<sect2 id="mainwindow_shares_konqueror"> -<title>Opening a Share</title> -<para>&smb4k; provides two possibilities to open a mounted share:</para> -<itemizedlist> -<listitem><formalpara><title>Open a share with &konsole;</title> -<para>You can open the mounted share in &konsole; by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut><guimenuitem>Open with Konsole</guimenuitem></menuchoice> action. This is useful if you need to run shell scripts on the share or similar.</para> -</formalpara></listitem> -<listitem><formalpara><title>Open a share with the default file manager</title> -<para>You can open the share in the default file manager (⪚ &dolphin;) by clicking the share icon or selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo></shortcut><guimenuitem>Open with File Manager</guimenuitem></menuchoice> action.</para> -</formalpara></listitem> -</itemizedlist> -<note><para>If a share is marked as inaccessible, it cannot be opened.</para></note> -</sect2> +<!-- + Using Smb4K : The Mounted Shares View : Opening a Share +--> + + <sect2 id="shares_view_opening_share"> + <title>Opening a Share</title> + + <para>&smb4k; provides two possibilities to open a mounted share:</para> + <itemizedlist> + <listitem><formalpara><title>Open a share with &konsole;</title> + <para>You can open the mounted share in &konsole; by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut><guimenuitem>Open with Konsole</guimenuitem></menuchoice> action. This is useful if you need to run shell scripts on the share or similar.</para> + </formalpara></listitem> + <listitem><formalpara><title>Open a share with the default file manager</title> + <para>You can open the share in the default file manager (⪚ &dolphin;) by clicking the share icon or selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo></shortcut><guimenuitem>Open with File Manager</guimenuitem></menuchoice> action.</para> + </formalpara></listitem> + </itemizedlist> + <note><para>If a share is marked as inaccessible, it cannot be opened.</para></note> + </sect2> </sect1> <!-- Using Smb4K : The System Tray Widget -->
