Git commit 14a4b9cb7eef93e3712bb2ad7804606c3f78bb5c by Alexander Reinholdt. Committed on 05/01/2017 at 20:32. Pushed by areinholdt into branch 'master'.
Updated handbook. A +- -- doc/configuration_page_profiles_add_profile.png D +- -- doc/configuration_profiles_add_profile.png M +981 -978 doc/index.docbook A +- -- doc/notification_missing_program.png D +- -- doc/notification_program_missing.png https://commits.kde.org/smb4k/14a4b9cb7eef93e3712bb2ad7804606c3f78bb5c diff --git a/doc/configuration_page_profiles_add_profile.png b/doc/configuration_page_profiles_add_profile.png new file mode 100644 index 0000000..36a276e Binary files /dev/null and b/doc/configuration_page_profiles_add_profile.png differ diff --git a/doc/configuration_profiles_add_profile.png b/doc/configuration_profiles_add_profile.png deleted file mode 100644 index 32e7daa..0000000 Binary files a/doc/configuration_profiles_add_profile.png and /dev/null differ diff --git a/doc/index.docbook b/doc/index.docbook index 4e09292..d3c4d3d 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -9,40 +9,40 @@ <book id="smb4k" lang="&language;" > <bookinfo> -<title>The &smb4k; Handbook</title> -<authorgroup> -<author> -<firstname>Alexander</firstname> -<othername></othername> -<surname>Reinholdt</surname> -<affiliation> -<address> -<email>alexander.reinholdt AT kdemail.net</email> -</address> -</affiliation> -</author> + <title>The &smb4k; Handbook</title> + <authorgroup> + <author> + <firstname>Alexander</firstname> + <othername></othername> + <surname>Reinholdt</surname> + <affiliation> + <address> + <email>alexander.reinholdt AT kdemail.net</email> + </address> + </affiliation> + </author> <!-- TRANS:ROLES_OF_TRANSLATORS --> -</authorgroup> -<copyright> -<year>2005-2016</year> -<holder>Alexander Reinholdt</holder> -</copyright> -<legalnotice>&underFDL;</legalnotice> -<date>2016-yy-xx</date> -<releaseinfo>6.0.0</releaseinfo> -<abstract> -<para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility.</para> -</abstract> -<keywordset> -<keyword>KDE</keyword> -<keyword>Smb4K</keyword> -<keyword>Samba</keyword> -</keywordset> + </authorgroup> + <copyright> + <year>2005-2016</year> + <holder>Alexander Reinholdt</holder> + </copyright> + <legalnotice>&underFDL;</legalnotice> + <date>2017-yy-xx</date> + <releaseinfo>6.0.0</releaseinfo> + <abstract> + <para>&smb4k; is an advanced network neighborhood browser and Samba share mounting utility.</para> + </abstract> + <keywordset> + <keyword>KDE</keyword> + <keyword>Smb4K</keyword> + <keyword>Samba</keyword> + </keywordset> </bookinfo> <!-- Introduction ---> + --> <chapter id="introduction" > <title>Introduction</title> @@ -77,995 +77,987 @@ <listitem><para>Profiles for different network neighborhood setups</para></listitem> </itemizedlist> - <note> - <para>The plasmoid has not been ported to &plasma; and QtQuick 2 yet. Thus, it has been disabled in this release. We are currently working on bringing this functionality back.</para> - </note> + <note><para>The plasmoid has not been ported to &plasma; and QtQuick 2 yet. Thus, it has been disabled in this release. We are currently working on bringing this functionality back.</para></note> <para>If you encounter problems while using &smb4k;, please visit our <ulink url="https://sourceforge.net/p/smb4k/wiki/Home/";>wiki</ulink> first. If you cannot find your problem described there, please post a help request to our <ulink url="https://sourceforge.net/p/smb4k/discussion/help/";>Help</ulink> forum. In case you find a bug, please report it to our <ulink url="https://bugs.kde.org/enter_bug.cgi?format=guided&product=smb4k";>bug tracker</ulink>.</para> <para>For discussions about &smb4k;-related topics there is the <ulink url="https://sourceforge.net/p/smb4k/discussion/general/";>General Discussion</ulink> forum and we invite every user to participate.</para> </chapter> -<!-- Using Smb4K --> +<!-- + Using Smb4K + --> <chapter id="using_smb4k"> -<title>Using &smb4k;</title> - -<!-- Using Smb4K : Running Smb4K --> - -<sect1 id="running_smb4k" > -<title>Running &smb4k;</title> - -<para>After the installation, you can run &smb4k; either from the K menu or from the command prompt by typing</para> -<screen><prompt>$</prompt> <userinput><command>smb4k</command></userinput></screen> -<para>&smb4k; does not take any arguments, except those that are known to all &kde; programs.</para> -<!--<para>&smb4k; also comes with a <link linkend="plasmoid">&plasmoid;</link> for better desktop integration. It can be added as widget to the desktop or the panel.</para>--> - -<note><para>If your system is missing some of the programs &smb4k; needs to operate properly, it notifies the user:</para> -<screenshot id="notification_missing_program"> -<screeninfo>Screenshot of the missing program notification</screeninfo> -<mediaobject> -<imageobject> -<imagedata fileref="notification_program_missing.png" format="PNG" /> -</imageobject> -<textobject> -<phrase>The missing program notification</phrase> -</textobject> -</mediaobject> -</screenshot> -<para>In this case, please install the specified program or, if it is already present, add its location to the <envar>PATH</envar> environment variable in your shell's configuration file (for the <ulink url="man:/bash"><citerefentry><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> shell it is the <filename>~/.bashrc</filename> file).</para> + <title>Using &smb4k;</title> -<para>In addition, it is recommended that you configure Samba before using &smb4k;. You may use the web-based <ulink url="man:/swat"><citerefentry><refentrytitle>swat</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> utility for this purpose if you have Samba 3 installed. However, it was removed from Samba 4. In this case, you can use other graphical tools (⪚ <application>system-config-samba</application>) or configure the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> file manually.</para></note> -</sect1> +<!-- + Using Smb4K : Running Smb4K + --> -<!-- Using Smb4K : Main Window --> - -<sect1 id="mainwindow_overview"> -<title>The Main Window</title> -<para>On the first start-up, the main window of &smb4k; looks similar to the one shown below. The network neighborhood browser (<guilabel>Network Neighborhood</guilabel>), the network search widget (<guilabel>Network Search</guilabel>) and the mounted shares view (<guilabel>Mounted Shares</guilabel>) are arranged in a tab widget. Above them the menubar and toolbar(s) are located. Below them you find the status bar.</para> -<screenshot id="mainwindow_overview_screenshot"> - <screeninfo>Screenshot of the main window</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="main_window.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The main window</phrase> - </textobject> - </mediaobject> -</screenshot> + <sect1 id="running_smb4k" > + <title>Running &smb4k;</title> -<para>&smb4k; comes with a compact unified toolbar as the default, but the user can still choose to use multiple toolbars. If you wish to use the classical way, four toolbars are defined, for each widget one: the main toolbar, the toolbars for the <guilabel>Network Neighborhood</guilabel> widget, the <guilabel>Shares View</guilabel> widget and the <guilabel>Network Search</guilabel> widget. The unified toolbar contains some of the main actions, like <guimenuitem>Configure &smb4k;</guimenuitem> and <guimenuitem>Quit</guimenuitem>. It also dynamically loads the actions of the dock widget that currently has got the focus. For additional information and some important warnings, please have a look at the sections discussing the <link linkend="network_neighborhood_browser">network neighborhood browser</link>, <link linkend="network_search_view">search dialog</link>, and <link linkend="shares_view">mounted shares view</link>.</para> + <para>After the installation, you can run &smb4k; either from the K menu or from the command prompt by typing <screen><prompt>$</prompt> <userinput><command>smb4k</command></userinput></screen></para> + <para>&smb4k; does not take any arguments, except those that are known to all &kde; applications.</para> + <!--<para>&smb4k; also comes with a <link linkend="plasmoid">&plasmoid;</link> for better desktop integration. It can be added as widget to the desktop or the panel.</para>--> + <para>If your system is missing some of the programs &smb4k; needs to operate properly, it notifies the user:</para> + + <screenshot id="notification_missing_program"> + <screeninfo>Screenshot of the missing program notification</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="notification_missing_program.png" format="PNG" /></imageobject> + <textobject><phrase>The missing program notification</phrase></textobject> + </mediaobject> + </screenshot> + + <para>In this case, please install the specified program or, if it is already present, add its location to the <envar>PATH</envar> environment variable in your shell's configuration file (for the <ulink url="man:/bash"><citerefentry><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> shell it is the <filename>~/.bashrc</filename> file).</para> + <para>In addition, it is recommended that you configure Samba before using &smb4k;. You may use the web-based <ulink url="man:/swat"><citerefentry><refentrytitle>swat</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> utility for this purpose if you have Samba 3 installed. However, it was removed from Samba 4. With this version, you can use other graphical tools (⪚ <application>system-config-samba</application>) or configure the <ulink url="man:/smb.conf"><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></ulink> file manually.</para> + </sect1> -<para>The status bar gives some information about the current status of &smb4k;. If the application is processing a user request (⪚ mounting a share), a descriptive message is displayed in the leftmost section and a progress bar is shown with a busy indicator. The two icons on the right hand side indicate if there are shares mounted (remote folder icon) and the status of the authentication system (wallet or key icon).</para> +<!-- + Using Smb4K : Main Window + --> -<para>If the dock widgets are arranged as tabs, the user gets additional visual feedback. Each time a share is mounted or unmounted, the <guilabel>Mounted Shares</guilabel> tab is highlighted for a few seconds.</para> + <sect1 id="mainwindow_overview"> + <title>The Main Window</title> + + <para>On the first start-up, the main window of &smb4k; looks similar to the one shown below. The network neighborhood browser (<guilabel>Network Neighborhood</guilabel>), the network search widget (<guilabel>Network Search</guilabel>) and the mounted shares view (<guilabel>Mounted Shares</guilabel>) are arranged in a tab widget. Above them the menubar and toolbar(s) are located. Below them you find the status bar.</para> + + <screenshot id="mainwindow_overview_screenshot"> + <screeninfo>Screenshot of the main window</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="main_window.png" format="PNG" /></imageobject> + <textobject><phrase>The main window</phrase></textobject> + </mediaobject> + </screenshot> -<para>The main window is highly configurable. You can hide or show all tabbed widgets (<menuchoice><guimenu>Settings</guimenu><guimenuitem>Dock Widgets</guimenuitem></menuchoice>). They can also be dragged around with the mouse and docked to different areas in the main window. You can even detach them from the main window. The status bar and the toolbars can be hidden/shown by toggling the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice> and the ones under <menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice>, respectively.</para> -</sect1> + <para>&smb4k; comes with a compact unified toolbar as the default, but the user can still choose to use multiple toolbars. If you wish to use the classical way, four toolbars are defined, for each widget one: the main toolbar, the toolbars for the <guilabel>Network Neighborhood</guilabel> widget, the <guilabel>Shares View</guilabel> widget and the <guilabel>Network Search</guilabel> widget. The unified toolbar contains some of the main actions, like <guimenuitem>Configure &smb4k;</guimenuitem> and <guimenuitem>Quit</guimenuitem>. It also dynamically loads the actions of the dock widget that currently has got the focus. For additional information and some important warnings, please have a look at the sections discussing the <link linkend="network_neighborhood_browser">network neighborhood browser</link>, <link linkend="network_search_view">search dialog</link>, and <link linkend="shares_view">mounted shares view</link>.</para> + <para>The status bar gives some information about the current status of &smb4k;. If the application is processing a user request (⪚ mounting a share), a descriptive message is displayed in the leftmost section and a progress bar is shown with a busy indicator. The two icons on the right hand side indicate if there are shares mounted (remote folder icon) and the status of the authentication system (wallet or key icon).</para> + <para>If the dock widgets are arranged as tabs, the user gets additional visual feedback. Each time a share is mounted or unmounted, the <guilabel>Mounted Shares</guilabel> tab is highlighted for a few seconds.</para> + <para>The main window is highly configurable. You can hide or show all tabbed widgets (<menuchoice><guimenu>Settings</guimenu><guimenuitem>Dock Widgets</guimenuitem></menuchoice>). They can also be dragged around with the mouse and docked to different areas in the main window. You can even detach them from the main window. The status bar and the toolbars can be hidden/shown by toggling the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice> and the ones under <menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice>, respectively.</para> + </sect1> <!-- Using Smb4K : The Network Neighborhood Browser ---> + --> -<sect1 id="network_neighborhood_browser"> - <title>The Network Neighborhood Browser</title> + <sect1 id="network_neighborhood_browser"> + <title>The Network Neighborhood Browser</title> - <para>The interaction with the network neighborhood is done with the <guilabel>Network Neighborhood</guilabel> browser. It contains all network items — &ie; workgroups, servers, and shares — &smb4k; was able to find. They are organized in a network tree, and you can navigate through it by either clicking the control next to the item name or by executing the item itself.</para> - <para>In the network tree, the master browser of each workgroup or domain is highlighted by blue font color. Mounted shares are marked with the respective folder icon and an italic font.</para> + <para>The interaction with the network neighborhood is done with the <guilabel>Network Neighborhood</guilabel> browser. It contains all network items — &ie; workgroups, servers, and shares — &smb4k; was able to find. They are organized in a network tree, and you can navigate through it by either clicking the control next to the item name or by executing the item itself.</para> + <para>In the network tree, the master browser of each workgroup or domain is highlighted by blue font color. Mounted shares are marked with the respective folder icon and an italic font.</para> - <screenshot> - <screeninfo>Screenshot of the network neighborhood browser</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="network_neighborhood_browser.png" format="PNG" /></imageobject> - <textobject><phrase>The network neighborhood browser</phrase></textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Screenshot of the network neighborhood browser</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="network_neighborhood_browser.png" format="PNG" /></imageobject> + <textobject><phrase>The network neighborhood browser</phrase></textobject> + </mediaobject> + </screenshot> - <para>The selection of multiple network items is supported. So, it is possible to ⪚ mount or preview several shares at once.</para> + <para>The selection of multiple network items is supported. So, it is possible to ⪚ mount or preview several shares at once.</para> <!-- Using Smb4K : The Network Neighborhood Browser : Browsing ---> - - <sect2 id="network_neighborhood_browser_browsing"> - <title>Browsing</title> - - <para>&smb4k; automatically scans the network neighborhood for active workgroups and domains on start-up and presents them in the network neighborhood browser. Opening a workgroup item shows the servers belonging to it. If you want to access the shares of one of the servers, you have to open the desired server.</para> + --> - <para>There are two scan modes available. The traditional one, where initially only workgroups and domains are looked up and scans are only made when necessary — &ie; when you execute a network item —, and one, where the network is scanned periodically for <emphasis>all</emphasis> available network items including servers and shares. While the former one is the default, the latter one can be enabled in the <link linkend="configuration_network_periodic_scanning">configuration dialog</link>.</para> + <sect2 id="network_neighborhood_browser_browsing"> + <title>Browsing</title> - <para>There are <link linkend="configuration_network_browselist">three methods</link> to retrieve the browse list: The default one is to scan the network neighborhood for all available master browsers. The second and third method directly query a master browser to get the browse list. The difference is that the former is a dynamic one, where the current master browser of your workgroup or domain is looked up and used, and the latter is a static one, where a fixed name or IP address is used. It is recommended that you choose the dynamic method. However, there might be circumstances that make it necessary to use a static name or IP address.</para> - - <para>There is also the possibility to wake up sleeping servers prior to scanning the network neighborhood (Wake-On-LAN). If this feature is enabled, &smb4k; sends a magic package to each server that is to be woken up and waits the defined time until it starts the lookup of the workgroups and domains. The Wake-On-LAN setting can be turned on in the <link linkend="configuration_network_wake_on_lan">configuration dialog</link>. The servers that should to be woken up have to be defined in the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog.</para> - </sect2> + <para>&smb4k; automatically scans the network neighborhood for active workgroups and domains on start-up and presents them in the network neighborhood browser. Opening a workgroup item shows the servers belonging to it. If you want to access the shares of one of the servers, you have to open the desired server.</para> + <para>There are two scan modes available. The traditional one, where initially only workgroups and domains are looked up and scans are only made when necessary — &ie; when you execute a network item —, and one, where the network is scanned periodically for <emphasis>all</emphasis> available network items including servers and shares. While the former one is the default, the latter one can be enabled in the <link linkend="configuration_network_periodic_scanning">configuration dialog</link>.</para> + <para>There are <link linkend="configuration_network_browselist">three methods</link> to retrieve the browse list: The default one is to scan the network neighborhood for all available master browsers. The second and third method directly query a master browser to get the browse list. The difference is that the former is a dynamic one, where the current master browser of your workgroup or domain is looked up and used, and the latter is a static one, where a fixed name or IP address is used. It is recommended that you choose the dynamic method. However, there might be circumstances that make it necessary to use a static name or IP address.</para> + <para>There is also the possibility to wake up sleeping servers prior to scanning the network neighborhood (Wake-On-LAN). If this feature is enabled, &smb4k; sends a magic package to each server that is to be woken up and waits the defined time until it starts the lookup of the workgroups and domains. The Wake-On-LAN setting can be turned on in the <link linkend="configuration_network_wake_on_lan">configuration dialog</link>. The servers that should to be woken up have to be defined in the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog.</para> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Actions and Popup Menu ---> + --> - <sect2 id="network_neighborhood_browser_actions_popup_menu"> - <title>Actions and Popup Menu</title> + <sect2 id="network_neighborhood_browser_actions_popup_menu"> + <title>Actions and Popup Menu</title> - <para>For the network neighborhood browser several actions are defined. They are present in the menubar under <guimenu>Network</guimenu>, in the toolbar and the popup menu. The following ones are available:</para> - - <variablelist> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycap>F5</keycap></shortcut> - <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Scan the whole network neighborhood, the highlighted workgroup/domain or computer for new entries. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network scan is running.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut> - <guimenuitem>Abort</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Abort any running process of the network neighborhood browser. This action is invisible by default and will only be visible instead of the <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem> action when a network scan is running.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <guimenuitem>Add Bookmark</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Add a bookmark to the currently selected remote share. This action is disabled if no share is selected.</para> - <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut> - <guimenuitem>Open Mount Dialog</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for mounting shares "manually". This feature may be needed if &smb4k; cannot find a server from which you want to mount a certain shared resource.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut> - <guimenuitem>Authentication</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the <link linkend="network_neighborhood_browser_authentication">authentication dialog</link>. You can provide the login and password for the selected server or share. If a workgroup or no item is selected, this action is disabled.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut> - <guimenuitem>Custom Options</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog. You can set several custom options for the selected server or share. If a workgroup or no item is selected, this menu entry is disabled.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut> - <guimenuitem>Preview</guimenuitem> - </menuchoice> - </term> - <listitem> - <para><link linkend="network_neighborhood_browser_previewing">Preview</link> the contents of the selected remote share. This action is only enabled if a share is selected. Printer shares cannot be previewed.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut> - <guimenuitem>Print File</guimenuitem> - </menuchoice> - </term> - <listitem> - <para><link linkend="network_neighborhood_browser_printing">Print</link> a file on a remote printer. This action is only available if a printer share is selected.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut> - <guimenuitem>Mount</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Mount the selected remote share. By default and if you clicked anything different than a share with type "Disk" or "IPC", this action is disabled. If you selected a mounted share, this action is replaced by the <guimenuitem>Unmount</guimenuitem> action.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> - <guimenuitem>Unmount</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Unmount the selected share. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action when the share is currently mounted.</para> - </listitem> - </varlistentry> - </variablelist> + <para>For the network neighborhood browser several actions are defined. They are present in the menubar under <guimenu>Network</guimenu>, in the toolbar and the popup menu. The following ones are available:</para> + + <variablelist> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycap>F5</keycap></shortcut> + <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Scan the whole network neighborhood, the highlighted workgroup/domain or computer for new entries. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network scan is running.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut> + <guimenuitem>Abort</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Abort any running process of the network neighborhood browser. This action is invisible by default and will only be visible instead of the <guimenuitem>Scan Network|Workgroup|Computer</guimenuitem> action when a network scan is running.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenuitem>Add Bookmark</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Add a bookmark to the currently selected remote share. This action is disabled if no share is selected.</para> + <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut> + <guimenuitem>Open Mount Dialog</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for mounting shares "manually". This feature may be needed if &smb4k; cannot find a server from which you want to mount a certain shared resource.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut> + <guimenuitem>Authentication</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Open the <link linkend="network_neighborhood_browser_authentication">authentication dialog</link>. You can provide the login and password for the selected server or share. If a workgroup or no item is selected, this action is disabled.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut> + <guimenuitem>Custom Options</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Open the <link linkend="network_neighborhood_browser_defining_custom_options">Custom Options</link> dialog. You can set several custom options for the selected server or share. If a workgroup or no item is selected, this menu entry is disabled.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut> + <guimenuitem>Preview</guimenuitem> + </menuchoice> + </term> + <listitem> + <para><link linkend="network_neighborhood_browser_previewing">Preview</link> the contents of the selected remote share. This action is only enabled if a share is selected. Printer shares cannot be previewed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut> + <guimenuitem>Print File</guimenuitem> + </menuchoice> + </term> + <listitem> + <para><link linkend="network_neighborhood_browser_printing">Print</link> a file on a remote printer. This action is only available if a printer share is selected.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut> + <guimenuitem>Mount</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Mount the selected remote share. By default and if you clicked anything different than a share with type "Disk" or "IPC", this action is disabled. If you selected a mounted share, this action is replaced by the <guimenuitem>Unmount</guimenuitem> action.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> + <guimenuitem>Unmount</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Unmount the selected share. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action when the share is currently mounted.</para> + </listitem> + </varlistentry> + </variablelist> - <para>Although you can interact with the network neighborhood using the keyboard shortcuts mentioned above, in most cases it is more convenient to use the mouse. By right clicking you can open a popup menu. It contains all actions that are available in the network neighborhood browser. Depending on the position where you clicked (on a network item or on the viewport), some of them may be disabled. The figure below shows the popup menu opened on a remote share.</para> + <para>Although you can interact with the network neighborhood using the keyboard shortcuts mentioned above, in most cases it is more convenient to use the mouse. By right clicking you can open a popup menu. It contains all actions that are available in the network neighborhood browser. Depending on the position where you clicked (on a network item or on the viewport), some of them may be disabled. The figure below shows the popup menu opened on a remote share.</para> - <screenshot> - <screeninfo>Screenshot of the popup menu of the network neighborhood browser</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="network_neighborhood_browser_popup_menu.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The popup menu of the network neighborhood browser</phrase> - </textobject> - </mediaobject> - </screenshot> - </sect2> + <screenshot> + <screeninfo>Screenshot of the popup menu of the network neighborhood browser</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="network_neighborhood_browser_popup_menu.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The popup menu of the network neighborhood browser</phrase> + </textobject> + </mediaobject> + </screenshot> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Tooltips ---> + --> - <sect2 id="network_neighborhood_browser_tooltips"> - <title>Tooltips</title> + <sect2 id="network_neighborhood_browser_tooltips"> + <title>Tooltips</title> - <para>For each network item a tooltip is provided that contains various information like the name of the workgroup and master browser, the name and IP address of the host, the name of the share, &etc;</para> - <para>The tooltips can be disabled in the <link linkend="configuration_user_interface_network_tooltips">configuration dialog</link>.</para> - </sect2> + <para>For each network item a tooltip is provided that contains various information like the name of the workgroup and master browser, the name and IP address of the host, the name of the share, &etc;</para> + <para>The tooltips can be disabled in the <link linkend="configuration_user_interface_network_tooltips">configuration dialog</link>.</para> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Mounting a Share ---> + --> + + <sect2 id="network_neighborhood_browser_mounting"> + <title>Mounting a Share</title> + + <para>There are three options available to mount a remote share:</para> + + <orderedlist> + <listitem><para>Execute the icon representing the remote share in the network neighborhood browser. (Depending on your &kde; settings, this is done by either single or double clicking the icon.)</para></listitem> + <listitem><para>Select the remote share and click the <guimenuitem>Mount</guimenuitem> menu entry. Alternatively, you can press the <keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo> keyboard shortcut.</para></listitem> + <listitem><para>If &smb4k; was not able to find the server where the share is located, you can press the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice> menu entry and a mount dialog will be opened:</para> + <screenshot> + <screeninfo>Screenshot of the "Mount Share" dialog</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="network_neighborhood_browser_mount_dialog.png" format="PNG" /></imageobject> + <textobject><phrase>The "Mount Share" dialog</phrase></textobject> + </mediaobject> + </screenshot> + <para>Here you can enter the location of the share either as <ulink url="http://en.wikipedia.org/wiki/Uniform_Naming_Convention#Uniform_Naming_Convention";>Uniform Naming Convention (UNC)</ulink> address in the form <programlisting>//[USER@]SERVER/SHARE</programlisting> or <programlisting>\\[USER@]SERVER\SHARE</programlisting> or as URL in the form <programlisting>[smb:]//[user@]server:port/share</programlisting> The <guibutton>OK</guibutton> button will be enabled and you can press it to mount the share. However, it is advisable to enter the IP address and the workgroup of the server, too. If you want to add the share to the bookmarks at the same time, tick the <guibutton>Add this share to the bookmarks</guibutton> check box.</para></listitem> + </orderedlist> + + <para>Often a share is password protected. In this case, an <link linkend="network_neighborhood_browser_authentication">authentication dialog</link> will appear and you have to enter the correct user name (if not already provided) and password. &smb4k; will proceed mounting the share unless a wrong user name or password was supplied. In that case, the authentication dialog will reappear. If the mount process was successful, the user will be shown a notification and the share will appear in the <link linkend="shares_view">mounted shares view</link>. If mounting fails, a notification with the error message that was returned by <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (&Linux;) or <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (FreeBSD, NetBSD) will be shown.</para> + </sect2> - <sect2 id="network_neighborhood_browser_mounting"> - <title>Mounting a Share</title> +<!-- + Using Smb4K : The Network Neighborhood Browser : Printing Files + --> - <para>There are three options available to mount a remote share:</para> + <sect2 id="network_neighborhood_browser_printing"> + <title>Printing Files on Remote Printers</title> - <orderedlist> - <listitem><para>Execute the icon representing the remote share in the network neighborhood browser. (Depending on your &kde; settings, this is done by either single or double clicking the icon.)</para></listitem> - <listitem><para>Select the remote share and click the <guimenuitem>Mount</guimenuitem> menu entry. Alternatively, you can press the <keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo> keyboard shortcut.</para></listitem> - <listitem><para>If &smb4k; was not able to find the server where the share is located, you can press the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>O</keycap></keycombo></shortcut><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice> menu entry and a mount dialog will be opened:</para> + <para>To print a file on a remote printer, open the print dialog by clicking the printer icon or choosing the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut><guimenuitem>Print File</guimenuitem></menuchoice> menu item.</para> <screenshot> - <screeninfo>Screenshot of the "Mount Share" dialog</screeninfo> + <screeninfo>Screenshot of the print dialog</screeninfo> <mediaobject> - <imageobject><imagedata fileref="network_neighborhood_browser_mount_dialog.png" format="PNG" /></imageobject> - <textobject><phrase>The "Mount Share" dialog</phrase></textobject> + <imageobject><imagedata fileref="network_neighborhood_browser_print_dialog.png" format="PNG" /></imageobject> + <textobject><phrase>The print dialog</phrase></textobject> </mediaobject> </screenshot> - <para>Here you can enter the location of the share either as <ulink url="http://en.wikipedia.org/wiki/Uniform_Naming_Convention#Uniform_Naming_Convention";>Uniform Naming Convention (UNC)</ulink> address in the form <programlisting>//[USER@]SERVER/SHARE</programlisting> or <programlisting>\\[USER@]SERVER\SHARE</programlisting> or as URL in the form <programlisting>[smb:]//[user@]server:port/share</programlisting> The <guibutton>OK</guibutton> button will be enabled and you can press it to mount the share. However, it is advisable to enter the IP address and the workgroup of the server, too. If you want to add the share to the bookmarks at the same time, tick the <guibutton>Add this share to the bookmarks</guibutton> check box.</para></listitem> - </orderedlist> - - <para>Often a share is password protected. In this case, an <link linkend="network_neighborhood_browser_authentication">authentication dialog</link> will appear and you have to enter the correct user name (if not already provided) and password. &smb4k; will proceed mounting the share unless a wrong user name or password was supplied. In that case, the authentication dialog will reappear. If the mount process was successful, the user will be shown a notification and the share will appear in the <link linkend="shares_view">mounted shares view</link>. If mounting fails, a notification with the error message that was returned by <ulink url="man:/mount.cifs"><citerefentry><refentrytitle>mount.cifs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (&Linux;) or <ulink url="man:/mount_smbfs"><citerefentry><refentrytitle>mount_smbfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> (FreeBSD, NetBSD) will be shown.</para> - </sect2> - -<!-- - Using Smb4K : The Network Neighborhood Browser : Printing Files ---> - - <sect2 id="network_neighborhood_browser_printing"> - <title>Printing Files on Remote Printers</title> - - <para>To print a file on a remote printer, open the print dialog by clicking the printer icon or choosing the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>P</keycap></keycombo></shortcut><guimenuitem>Print File</guimenuitem></menuchoice> menu item.</para> - <screenshot> - <screeninfo>Screenshot of the print dialog</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="network_neighborhood_browser_print_dialog.png" format="PNG" /></imageobject> - <textobject><phrase>The print dialog</phrase></textobject> - </mediaobject> - </screenshot> - <para>In the <guilabel>Printer</guilabel> section various information about the printer is shown. Under <guilabel>File</guilabel> you have to provide the path to the file you want to print. The number of copies can be defined under <guibutton>Options >></guibutton>. Press <guibutton>Print...</guibutton> to start the print process.</para> - <para>&smb4k; currently supports PDF, Postscript, image, and text files. If you try to print a file with an unsupported mimetype, a notification with an error message will appear telling you the mimetype is not supported. In this case you have to convert the file manually to Postscript or PDF and try again.</para> - </sect2> + <para>In the <guilabel>Printer</guilabel> section various information about the printer is shown. Under <guilabel>File</guilabel> you have to provide the path to the file you want to print. The number of copies can be defined under <guibutton>Options >></guibutton>. Press <guibutton>Print...</guibutton> to start the print process.</para> + <para>&smb4k; currently supports PDF, Postscript, image, and text files. If you try to print a file with an unsupported mimetype, a notification with an error message will appear telling you the mimetype is not supported. In this case you have to convert the file manually to Postscript or PDF and try again.</para> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Previewing Shares ---> + --> - <sect2 id="network_neighborhood_browser_previewing"> - <title>Previewing Shares</title> - - <para>&smb4k; provides the ability to preview remote shares. If you click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut><guimenuitem>Preview</guimenuitem></menuchoice> menu entry, the contents of the selected remote share will be opened in a preview dialog.</para> - <screenshot> - <screeninfo>Screenshot of the preview dialog</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="network_neighborhood_browser_preview_dialog.png" format="PNG" /></imageobject> - <textobject><phrase>The preview dialog</phrase></textobject> - </mediaobject> - </screenshot> - <para>The preview dialog acts like a simple file manager. You can navigate through the contents of the remote share by clicking the folder icons in the list view and the <guibutton>Up</guibutton>, <guibutton>Back</guibutton>, and <guibutton>Forward</guibutton> button. The current location is displayed in the combo box on the right hand side. The <guibutton>Reload</guibutton> button reloads the contents of the current folder.</para> - <para>By default, the preview dialog only shows folders and files that are not hidden. You can change this behavior in the <link linkend="configuration_network_general_behavior">configuration dialog</link>. File transfers or the like are not possible.</para> - </sect2> + <sect2 id="network_neighborhood_browser_previewing"> + <title>Previewing Shares</title> + + <para>&smb4k; provides the ability to preview remote shares. If you click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>V</keycap></keycombo></shortcut><guimenuitem>Preview</guimenuitem></menuchoice> menu entry, the contents of the selected remote share will be opened in a preview dialog.</para> + <screenshot> + <screeninfo>Screenshot of the preview dialog</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="network_neighborhood_browser_preview_dialog.png" format="PNG" /></imageobject> + <textobject><phrase>The preview dialog</phrase></textobject> + </mediaobject> + </screenshot> + <para>The preview dialog acts like a simple file manager. You can navigate through the contents of the remote share by clicking the folder icons in the list view and the <guibutton>Up</guibutton>, <guibutton>Back</guibutton>, and <guibutton>Forward</guibutton> button. The current location is displayed in the combo box on the right hand side. The <guibutton>Reload</guibutton> button reloads the contents of the current folder.</para> + <para>By default, the preview dialog only shows folders and files that are not hidden. You can change this behavior in the <link linkend="configuration_network_general_behavior">configuration dialog</link>. File transfers or the like are not possible.</para> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Providing Authentication Information ---> + --> - <sect2 id="network_neighborhood_browser_authentication"> - <title>Providing Authentication Information</title> + <sect2 id="network_neighborhood_browser_authentication"> + <title>Providing Authentication Information</title> - <para>Many servers or remote shares are password protected. In that case, a password dialog appears asking you for the user name and password. The same happens, if you click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut><guimenuitem>Authentication</guimenuitem></menuchoice> menu entry.</para> - <screenshot> - <screeninfo>Screenshot of the authentication dialog</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="network_neighborhood_browser_authentication_dialog.png" format="PNG" /></imageobject> - <textobject><phrase>The authentication dialog</phrase></textobject> - </mediaobject> - </screenshot> - <para>If a user name has already been provided, it will be shown in the respective field. If it is wrong or no user name was provided, you have to enter one. The password, however, may be left blank. Clicking the <guibutton>OK</guibutton> button will commit the data. Depending on your choice in the <link linkend="configuration_page_authentication">configuration dialog</link>, the user name and password will be stored permanently in a digital wallet or not all. In the latter case you will have to provide them <emphasis>every time</emphasis> they are needed.</para> -</sect2> + <para>Many servers or remote shares are password protected. In that case, a password dialog appears asking you for the user name and password. The same happens, if you click the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>T</keycap></keycombo></shortcut><guimenuitem>Authentication</guimenuitem></menuchoice> menu entry.</para> + <screenshot> + <screeninfo>Screenshot of the authentication dialog</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="network_neighborhood_browser_authentication_dialog.png" format="PNG" /></imageobject> + <textobject><phrase>The authentication dialog</phrase></textobject> + </mediaobject> + </screenshot> + <para>If a user name has already been provided, it will be shown in the respective field. If it is wrong or no user name was provided, you have to enter one. The password, however, may be left blank. Clicking the <guibutton>OK</guibutton> button will commit the data. Depending on your choice in the <link linkend="configuration_page_authentication">configuration dialog</link>, the user name and password will be stored permanently in a digital wallet or not all. In the latter case you will have to provide them <emphasis>every time</emphasis> they are needed.</para> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Defining Custom Options ---> + --> - <sect2 id="network_neighborhood_browser_defining_custom_options"> - <title>Defining Custom Options</title> + <sect2 id="network_neighborhood_browser_defining_custom_options"> + <title>Defining Custom Options</title> - <para>Use the <guilabel>Custom Options</guilabel> dialog if you want to</para> - <itemizedlist> - <listitem><para>define custom Samba options for a single server or share that deviate from the ones defined in the configuration dialog,</para></listitem> - <listitem><para>define a server that should be woken up prior to network scans or mount attempts (Wake-On-LAN feature, see <link linkend="configuration_network_wake_on_lan">here</link>),</para></listitem> - <listitem><para>always mount a certain share on start-up or if the corresponding profile is loaded.</para></listitem> - </itemizedlist> - <para>The dialog is opened by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Custom Options</guimenuitem></menuchoice> menu entry.</para> + <para>Use the <guilabel>Custom Options</guilabel> dialog if you want to</para> + <itemizedlist> + <listitem><para>define custom Samba options for a single server or share that deviate from the ones defined in the configuration dialog,</para></listitem> + <listitem><para>define a server that should be woken up prior to network scans or mount attempts (Wake-On-LAN feature, see <link linkend="configuration_network_wake_on_lan">here</link>),</para></listitem> + <listitem><para>always mount a certain share on start-up or if the corresponding profile is loaded.</para></listitem> + </itemizedlist> + <para>The dialog is opened by clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>C</keycap></keycombo></shortcut><guimenuitem>Custom Options</guimenuitem></menuchoice> menu entry.</para> - <screenshot> - <screeninfo>Screenshot of the custom options dialog for a share</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="network_neighborhood_browser_custom_options_dialog.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The custom options dialog</phrase> - </textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Screenshot of the custom options dialog for a share</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="network_neighborhood_browser_custom_options_dialog.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The custom options dialog</phrase> + </textobject> + </mediaobject> + </screenshot> - <para>The <guibutton>Default</guibutton> button is enabled if the entries in the dialog deviate from the settings you defined in the configuration dialog. By clicking it, you can reset the entries in the dialog to their default values. The <guibutton>OK</guibutton> button is enabled if you changed the settings in the dialog. Clicking it will commit the custom settings and close the dialog.</para> - <note><para>Under FreeBSD and NetBSD, the dialog contains less entries than if you run a different operating system, because several of the options are not supported.</para></note> + <para>The <guibutton>Default</guibutton> button is enabled if the entries in the dialog deviate from the settings you defined in the configuration dialog. By clicking it, you can reset the entries in the dialog to their default values. The <guibutton>OK</guibutton> button is enabled if you changed the settings in the dialog. Clicking it will commit the custom settings and close the dialog.</para> + <note><para>Under FreeBSD and NetBSD, the dialog contains less entries than if you run a different operating system, because several of the options are not supported.</para></note> - <sect3 id="network_neighborhood_browser_defining_custom_options_samba"> - <title>Samba</title> + <sect3 id="network_neighborhood_browser_defining_custom_options_samba"> + <title>Samba</title> - <para>Depending on your selection, the settings in the custom options dialog either apply to all shares of a server or to a single one. You can define the SMB port, the file system port (&Linux; only), the write access, the user ID, the group ID and if Kerberos should be used for authentication. For detailed information on the individual settings, please see <link linkend="configuration_page_samba">here</link>.</para> - </sect3> + <para>Depending on your selection, the settings in the custom options dialog either apply to all shares of a server or to a single one. You can define the SMB port, the file system port (&Linux; only), the write access, the user ID, the group ID and if Kerberos should be used for authentication. For detailed information on the individual settings, please see <link linkend="configuration_page_samba">here</link>.</para> + </sect3> - <sect3 id="network_neighborhood_browser_defining_custom_options_wol"> - <title>Wake-On-LAN</title> - - <para>To make the Wake-On-LAN feature work, you need to provide the MAC address of the server you selected. Currently, &smb4k; has no way to determine the MAC address, so you need to find it out on your own. Afterwards, you can define if &smb4k; should send a magic Wake-On-LAN package to the selected host before the network neighborhood is scanned and/or one of its shares is mounted.</para> - </sect3> - </sect2> + <sect3 id="network_neighborhood_browser_defining_custom_options_wol"> + <title>Wake-On-LAN</title> + + <para>To make the Wake-On-LAN feature work, you need to provide the MAC address of the server you selected. Currently, &smb4k; has no way to determine the MAC address, so you need to find it out on your own. Afterwards, you can define if &smb4k; should send a magic Wake-On-LAN package to the selected host before the network neighborhood is scanned and/or one of its shares is mounted.</para> + </sect3> + </sect2> <!-- Using Smb4K : The Network Neighborhood Browser : Adding Bookmarks ---> + --> - <sect2 id="network_neighborhood_browser_adding_bookmarks"> - <title>Adding Bookmarks</title> + <sect2 id="network_neighborhood_browser_adding_bookmarks"> + <title>Adding Bookmarks</title> - <para>A bookmark is added by selecting a remote share (only these can be bookmarked) and pressing the <keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo> keyboard shortcut or selecting the <guimenuitem>Add Bookmark</guimenuitem> menu item. The bookmark will then be accessible through the <guimenu>Bookmarks</guimenu> menu. See the section <link linkend="bookmarks">Bookmarks</link> for more details.</para> - <para>The bookmarks can be used to mount remote shares.</para> - </sect2> -</sect1> + <para>A bookmark is added by selecting a remote share (only these can be bookmarked) and pressing the <keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo> keyboard shortcut or selecting the <guimenuitem>Add Bookmark</guimenuitem> menu item. The bookmark will then be accessible through the <guimenu>Bookmarks</guimenu> menu. See the section <link linkend="bookmarks">Bookmarks</link> for more details.</para> + <para>The bookmarks can be used to mount remote shares.</para> + </sect2> + </sect1> <!-- Using Smb4K : The Network Search View ---> + --> -<sect1 id="network_search_view"> - <title>The Network Search View</title> + <sect1 id="network_search_view"> + <title>The Network Search View</title> - <para>The <guilabel>Network Search</guilabel> view consists of the combo box where you can enter the search item and a list view where the search results are shown.</para> - <screenshot> - <screeninfo>Screenshot of the network search view</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="network_search_view.png" format="PNG" /></imageobject> - <textobject><phrase>The network search view</phrase></textobject> - </mediaobject> - </screenshot> + <para>The <guilabel>Network Search</guilabel> view consists of the combo box where you can enter the search item and a list view where the search results are shown.</para> + <screenshot> + <screeninfo>Screenshot of the network search view</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="network_search_view.png" format="PNG" /></imageobject> + <textobject><phrase>The network search view</phrase></textobject> + </mediaobject> + </screenshot> <!-- Using Smb4K : The Network Search View : Searching ---> + --> - <sect2 id="network_search_view_searching"> - <title>Searching</title> + <sect2 id="network_search_view_searching"> + <title>Searching</title> - <para>&smb4k; searches the network neighborhood for shares that match or contain the search string. To start a search, enter the term into the input box - and either press the &Enter; key or click the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Search</guimenuitem></menuchoice> action next to the input box. All network shares that match the search criterion are listed in the list view. If they are already mounted on the system, they are marked accordingly. If the search fails, an error message is displayed. Starting a new search will clear the list view. If you need to abort a search, click the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut><guimenuitem>Abort</guimenuitem></menuchoice> action.</para> - </sect2> + <para>&smb4k; searches the network neighborhood for shares that match or contain the search string. To start a search, enter the term into the input box + and either press the &Enter; key or click the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Search</guimenuitem></menuchoice> action next to the input box. All network shares that match the search criterion are listed in the list view. If they are already mounted on the system, they are marked accordingly. If the search fails, an error message is displayed. Starting a new search will clear the list view. If you need to abort a search, click the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut><guimenuitem>Abort</guimenuitem></menuchoice> action.</para> + </sect2> <!-- Using Smb4K : The Network Search View : Actions and Popup Menu ---> + --> - <sect2 id="network_search_view_menu"> - <title>Actions and Popup Menu</title> + <sect2 id="network_search_view_menu"> + <title>Actions and Popup Menu</title> - <para>For the network search also several actions are defined. They are present in the menu bar under <guimenu>Search</guimenu>, the tool bar, in the widget itself and in its popup menu. The following ones are available:</para> + <para>For the network search also several actions are defined. They are present in the menu bar under <guimenu>Search</guimenu>, the tool bar, in the widget itself and in its popup menu. The following ones are available:</para> - <variablelist> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>S</keycap></keycombo></shortcut> - <guimenuitem>Search</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Search for the item that was entered in the search dialog. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network search is running.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut> - <guimenuitem>Abort</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Abort the network search. This action is invisible by default and will only be visible instead of the <guimenuitem>Search</guimenuitem> action if a network search is running.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <guimenuitem>Clear</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Clear the whole network search dialog. This action does not only clear the list view, but also the search item history in the combo box.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut> - <guimenuitem>Mount</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Mount a remote share from within the search dialog. Alternatively, you can double click the network share in the list view.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> - <guimenuitem>Unmount</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Unmount the selected share. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action when the share is currently mounted.</para> - </listitem> - </varlistentry> - </variablelist> + <variablelist> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>S</keycap></keycombo></shortcut> + <guimenuitem>Search</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Search for the item that was entered in the search dialog. This action is visible by default and will be replaced by the <guimenuitem>Abort</guimenuitem> action if a network search is running.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut> + <guimenuitem>Abort</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Abort the network search. This action is invisible by default and will only be visible instead of the <guimenuitem>Search</guimenuitem> action if a network search is running.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenuitem>Clear</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Clear the whole network search dialog. This action does not only clear the list view, but also the search item history in the combo box.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut> + <guimenuitem>Mount</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Mount a remote share from within the search dialog. Alternatively, you can double click the network share in the list view.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> + <guimenuitem>Unmount</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Unmount the selected share. This action is invisible by default and will only be visible instead of the <guimenuitem>Mount</guimenuitem> action when the share is currently mounted.</para> + </listitem> + </varlistentry> + </variablelist> - <para>The popup menu contains two entries: The <menuchoice><guimenuitem>Clear</guimenuitem></menuchoice> action and the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut><guimenuitem>Mount</guimenuitem></menuchoice> | <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> dual action. The <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Search</guimenuitem></menuchoice> | <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut><guimenuitem>Abort</guimenuitem></menuchoice> dual action is located next to the search input box (as well as in the menu bar and tool bar).</para> + <para>The popup menu contains two entries: The <menuchoice><guimenuitem>Clear</guimenuitem></menuchoice> action and the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>M</keycap></keycombo></shortcut><guimenuitem>Mount</guimenuitem></menuchoice> | <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> dual action. The <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Search</guimenuitem></menuchoice> | <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>A</keycap></keycombo></shortcut><guimenuitem>Abort</guimenuitem></menuchoice> dual action is located next to the search input box (as well as in the menu bar and tool bar).</para> - <screenshot> - <screeninfo>Screenshot of the network search view's popup menu</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="network_search_view_popup_menu.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The network search view's popup menu</phrase> - </textobject> - </mediaobject> - </screenshot> - </sect2> + <screenshot> + <screeninfo>Screenshot of the network search view's popup menu</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="network_search_view_popup_menu.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The network search view's popup menu</phrase> + </textobject> + </mediaobject> + </screenshot> + </sect2> <!-- Using Smb4K : The Network Search View : Mounting a Share ---> + --> - <sect2 id="network_search_view_adding"> - <title>Mounting a Share</title> + <sect2 id="network_search_view_adding"> + <title>Mounting a Share</title> - <para>A discovered share can directly be mounted by either double clicking it or by selecting it and choosing the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>D</keycap></keycombo></shortcut><guimenuitem>Mount</guimenuitem></menuchoice> action from the popup menu. When mounting a homes share, you are asked to provide the user name and a share with that name is mounted. The homes share itself will, thus, not be labeled as mounted afterwards. Due to a shortcoming of the utility program that does the actual search (the <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command), &smb4k; cannot discriminate between printer and normal shares. Mounting a printer share will fail and an error notification will be shown.</para> - </sect2> -</sect1> + <para>A discovered share can directly be mounted by either double clicking it or by selecting it and choosing the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>D</keycap></keycombo></shortcut><guimenuitem>Mount</guimenuitem></menuchoice> action from the popup menu. When mounting a homes share, you are asked to provide the user name and a share with that name is mounted. The homes share itself will, thus, not be labeled as mounted afterwards. Due to a shortcoming of the utility program that does the actual search (the <ulink url="man:/smbtree"><citerefentry><refentrytitle>smbtree</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> command), &smb4k; cannot discriminate between printer and normal shares. Mounting a printer share will fail and an error notification will be shown.</para> + </sect2> + </sect1> <!-- Using Smb4K : The Mounted Shares View ---> + --> + + <sect1 id="shares_view"> + <title>The Mounted Shares View</title> -<sect1 id="shares_view"> - <title>The Mounted Shares View</title> - <para>In the shares view, you can interact with the mounted shares on your system.</para> + <para>In the shares view, you can interact with the mounted shares on your system.</para> <!-- Using Smb4K : The Mounted Shares View : Different Views ---> + --> - <sect2 id="shares_view_views"> - <title>Different Views</title> + <sect2 id="shares_view_views"> + <title>Different Views</title> - <para>&smb4k; comes with two alternative views: an icon and a list view. They are both shown below. The default one is the icon view.</para> - <para>The icon view:</para> - <screenshot> - <screeninfo>Screenshot of the shares icon view</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="shares_view_icon_view.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The shares icon view</phrase> - </textobject> - </mediaobject> - </screenshot> - <para>The list view:</para> - <screenshot> - <screeninfo>Screenshot of the shares list view</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="shares_view_list_view.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The shares list view</phrase> - </textobject> - </mediaobject> - </screenshot> + <para>&smb4k; comes with two alternative views: an icon and a list view. They are both shown below. The default one is the icon view.</para> + <para>The icon view:</para> + <screenshot> + <screeninfo>Screenshot of the shares icon view</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="shares_view_icon_view.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The shares icon view</phrase> + </textobject> + </mediaobject> + </screenshot> + <para>The list view:</para> + <screenshot> + <screeninfo>Screenshot of the shares list view</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="shares_view_list_view.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The shares list view</phrase> + </textobject> + </mediaobject> + </screenshot> - <para>You can switch between the two views by selecting either the appropriate entry in the <guimenuitem>View Modes</guimenuitem> 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_shares_behavior">respective settings</link>.</para> - </sect2> + <para>You can switch between the two views by selecting either the appropriate entry in the <guimenuitem>View Modes</guimenuitem> 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_shares_behavior">respective settings</link>.</para> + </sect2> <!-- Using Smb4K : The Mounted Shares View : Actions and Popup Menu ---> + --> - <sect2 id="shares_view_actions_popup_menu"> - <title>Actions and Popup Menu</title> + <sect2 id="shares_view_actions_popup_menu"> + <title>Actions and Popup Menu</title> - <para>For the shares view several actions are defined. They are present in the menu bar under <guimenu>Shares</guimenu>, the tool bar and in its popup menu. The following ones are available:</para> + <para>For the shares view several actions are defined. They are present in the menu bar under <guimenu>Shares</guimenu>, the tool bar and in its popup menu. The following ones are available:</para> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>View Modes</guimenuitem></menuchoice> - </term> - <listitem> - <para>Choose the view mode from the submenu.</para> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Icon View</guimenuitem></menuchoice> - </term> - <listitem> - <para>The shares are shown in an icon view.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>List View</guimenuitem></menuchoice> - </term> - <listitem> - <para>The shares are shown in a list view.</para> - </listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> - <guimenuitem>Unmount</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Unmount 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_shares_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_shares_behavior">settings</link> in the configuration dialog.</para> - <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut> - <guimenuitem>Unmount All</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Unmount all shares at once. The restrictions noted above also apply here. If you do not have any shares mounted, this button is disabled.</para> - <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <guimenuitem>Add Bookmark</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Add a bookmark to the currently selected mounted share. This action is disabled if no share is selected.</para> - <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>Y</keycap></keycombo></shortcut> - <guimenuitem>Synchronize</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Start the <link linkend="shares_view_synchronization">synchronization</link> of a share with a local copy or vice versa. This menu entry is only enabled if you installed the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and a share is selected.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>L</keycap></keycombo></shortcut> - <guimenuitem>Open with Konsole</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the base folder of a share in &konsole;. This menu item is useful if you need to run shell scripts, &etc;</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>I</keycap></keycombo></shortcut> - <guimenuitem>Open with File Manager</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Open the contents of a share in the default file manager.</para> - </listitem> - </varlistentry> - </variablelist> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>View Modes</guimenuitem></menuchoice> + </term> + <listitem> + <para>Choose the view mode from the submenu.</para> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Icon View</guimenuitem></menuchoice> + </term> + <listitem> + <para>The shares are shown in an icon view.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>List View</guimenuitem></menuchoice> + </term> + <listitem> + <para>The shares are shown in a list view.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut> + <guimenuitem>Unmount</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Unmount 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_shares_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_shares_behavior">settings</link> in the configuration dialog.</para> + <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo></shortcut> + <guimenuitem>Unmount All</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Unmount all shares at once. The restrictions noted above also apply here. If you do not have any shares mounted, this button is disabled.</para> + <para>Read the <link linkend="shares_view_unmounting">Unmounting Shares</link> section for more details.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <guimenuitem>Add Bookmark</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Add a bookmark to the currently selected mounted share. This action is disabled if no share is selected.</para> + <para>Read the <link linkend="bookmarks_adding">Adding Bookmarks</link> section for more details.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>Y</keycap></keycombo></shortcut> + <guimenuitem>Synchronize</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Start the <link linkend="shares_view_synchronization">synchronization</link> of a share with a local copy or vice versa. This menu entry is only enabled if you installed the program <ulink url="man:/rsync"><citerefentry><refentrytitle>rsync</refentrytitle><manvolnum>1</manvolnum></citerefentry></ulink> and a share is selected.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>L</keycap></keycombo></shortcut> + <guimenuitem>Open with Konsole</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Open the base folder of a share in &konsole;. This menu item is useful if you need to run shell scripts, &etc;</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>I</keycap></keycombo></shortcut> + <guimenuitem>Open with File Manager</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Open the contents of a share in the default file manager.</para> + </listitem> + </varlistentry> + </variablelist> - <para>The popup menu includes all actions that can be performed on a mounted share:</para> - <screenshot> - <screeninfo>Screenshot of the popup menu of the shares view</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="shares_view_popup_menu.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>The popup menu of the shares view</phrase> - </textobject> - </mediaobject> - </screenshot> - <para>It can be opened by clicking the right mouse button.</para> - </sect2> + <para>The popup menu includes all actions that can be performed on a mounted share:</para> + <screenshot> + <screeninfo>Screenshot of the popup menu of the shares view</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="shares_view_popup_menu.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The popup menu of the shares view</phrase> + </textobject> + </mediaobject> + </screenshot> + <para>It can be opened by clicking the right mouse button.</para> + </sect2> <!-- Using Smb4K : The Mounted Shares View : Tooltips ---> + --> - <sect2 id="shares_view_tooltips"> - <title>Tooltips</title> + <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>Tooltips are enabled by default. You can deactivate them in the <link linkend="configuration_user_interface_shares_tooltips">configuration dialog</link>.</para> - </sect2> + <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>Tooltips are enabled by default. You can deactivate them in the <link linkend="configuration_user_interface_shares_tooltips">configuration dialog</link>.</para> + </sect2> <!-- Using Smb4K : The Mounted Shares View : Inaccessible Shares ---> + --> - <sect2 id="shares_view_inaccessible_shares"> - <title>Inaccessible Shares</title> + <sect2 id="shares_view_inaccessible_shares"> + <title>Inaccessible Shares</title> - <para>&smb4k; periodically checks all mounted shares if they are still accessible. If an inaccessible share is encountered, it will be marked with a <link linkend="shares_view_icons">locked folder icon</link> and you will not be able to open or synchronize it anymore. Unmounting and adding a bookmark is still possible.</para> - <note><para>The program might freeze for a short period of time due to an inaccessible share. It will recover afterwards.</para></note> - </sect2> + <para>&smb4k; periodically checks all mounted shares if they are still accessible. If an inaccessible share is encountered, it will be marked with a <link linkend="shares_view_icons">locked folder icon</link> and you will not be able to open or synchronize it anymore. Unmounting and adding a bookmark is still possible.</para> + <note><para>The program might freeze for a short period of time due to an inaccessible share. It will recover afterwards.</para></note> + </sect2> <!-- Using Smb4K : The Mounted Shares View : Icons ---> + --> - <sect2 id="shares_view_icons"> - <title>Icons</title> + <sect2 id="shares_view_icons"> + <title>Icons</title> - <para>Three different icons may be presented to the user:</para> - <screenshot> - <screeninfo>Screenshot of three different icons</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="shares_view_icons.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Three different icons</phrase> - </textobject> - </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 to do synchronization with 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_shares_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_shares_behavior">change this behavior</link>, too.</para></listitem> - </itemizedlist> - </sect2> + <para>Three different icons may be presented to the user:</para> + <screenshot> + <screeninfo>Screenshot of three different icons</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="shares_view_icons.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Three different icons</phrase> + </textobject> + </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 to do synchronization with 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_shares_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_shares_behavior">change this behavior</link>, too.</para></listitem> + </itemizedlist> + </sect2> <!-- Using Smb4K : The Mounted Shares View : Drag-and-Drop ---> + --> - <sect2 id="shares_view_drag_and_drop"> - <title>Drag-and-Drop</title> + <sect2 id="shares_view_drag_and_drop"> + <title>Drag-and-Drop</title> - <para>&smb4k; supports drag-and-drop in the shares view. To transfer or link data to a share, drag the files and/or folders over the share icon and drop them there. A popup menu will open asking you what you want to do. Choose the appropriate action (copy, move or link).</para> - <screenshot> - <screeninfo>Screenshot of the shares view after the user dropped a file</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="shares_view_drop_popup_menu.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>A popup menu opened after the user dropped a file onto a share</phrase> - </textobject> - </mediaobject> - </screenshot> - <para>To avoid the popup menu, press the &Shift; key for moving, the &Ctrl; key for copying and the <keycombo>&Ctrl;&Shift;</keycombo> key combination for linking while dragging and dropping. The transfer will only be successful if the share was mounted with read and write permissions.</para> - <para>You can also drag and drop the whole share to the desktop or to another application (⪚ &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> + <para>&smb4k; supports drag-and-drop in the shares view. To transfer or link data to a share, drag the files and/or folders over the share icon and drop them there. A popup menu will open asking you what you want to do. Choose the appropriate action (copy, move or link).</para> + <screenshot> + <screeninfo>Screenshot of the shares view after the user dropped a file</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="shares_view_drop_popup_menu.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>A popup menu opened after the user dropped a file onto a share</phrase> + </textobject> + </mediaobject> + </screenshot> + <para>To avoid the popup menu, press the &Shift; key for moving, the &Ctrl; key for copying and the <keycombo>&Ctrl;&Shift;</keycombo> key combination for linking while dragging and dropping. The transfer will only be successful if the share was mounted with read and write permissions.</para> + <para>You can also drag and drop the whole share to the desktop or to another application (⪚ &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 ---> + --> - <sect2 id="shares_view_unmounting"> - <title>Unmounting Shares</title> + <sect2 id="shares_view_unmounting"> + <title>Unmounting Shares</title> - <para>One or multiple selected shares may be unmounted by either clicking the <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>U</keycap></keycombo></shortcut><guimenuitem>Unmount</guimenuitem></menuchoice> action or by pressing its keyboard shortcut. By default, the ability to unmount a share is restricted to the ones that are owned by you. This behavior can be altered in the <link linkend="configuration_page_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="shares_view_warning_dialog_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="configuration_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> + <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_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="shares_view_warning_dialog_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="configuration_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> <!-- Using Smb4K : The Mounted Shares View : Synchronization ---> + --> - <sect2 id="shares_view_synchronization"> - <title>Synchronization</title> + <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="shares_view_synchronization_input_dialog.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>&URL; requester for sync'ing</phrase> - </textobject> - </mediaobject> - </screenshot> - <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization. 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="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> + <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="shares_view_synchronization_input_dialog.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>&URL; requester for sync'ing</phrase> + </textobject> + </mediaobject> + </screenshot> + <para>Clicking the <guibutton>Synchronize</guibutton> button starts the synchronization. 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="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> - <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> + <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> <!-- Using Smb4K : The Mounted Shares View : Opening a Share ---> + --> - <sect2 id="shares_view_opening_share"> - <title>Opening a Share</title> + <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> + <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 ---> + --> -<sect1 id="systemtray"> - <title>The System Tray Widget</title> + <sect1 id="systemtray"> + <title>The System Tray Widget</title> <!-- Using Smb4K : The System Tray Widget : Location and Usage ---> - - <sect2 id="systemtray_location_usage"> - <title>Location and Usage</title> - - <para>When &smb4k; is started, an icon appears in your system tray.</para> + --> - <screenshot> - <screeninfo>Screenshot of the system tray widget</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="systemtray_location.png" format="PNG" /></imageobject> - <textobject><phrase>System tray widget</phrase></textobject> - </mediaobject> - </screenshot> - - <para>By left clicking the icon, you can minimize or restore the main window. A right click brings up a popup menu that contains several menu items allowing you to work with the mounted shares, manage or mount your bookmarks, select the profile you want to use and to configure &smb4k; without the need to open the main window.</para> - </sect2> + <sect2 id="systemtray_location_usage"> + <title>Location and Usage</title> -<!-- - Using Smb4K : The System Tray Widget : Menus and Menu Items ---> + <para>When &smb4k; is started, an icon appears in your system tray.</para> - <sect2 id="systemtray_menus"> - <title>Menus and Menu Items</title> - - <para>The <guimenuitem>Mounted Shares</guimenuitem> menu lists all mounted shares and some actions that can be performed on them.</para> - - <screenshot> - <screeninfo>Screenshot of the Mounted Shares popup menu of the system tray widget</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="systemtray_mounted_shares_menu.png" format="PNG" /></imageobject> - <textobject><phrase>System tray widget's Mounted Shares menu</phrase></textobject> - </mediaobject> - </screenshot> - - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Unmount All</guimenuitem></menuchoice> - </term> - <listitem> - <para>Unmount all shares at once. Depending on your <link linkend="configuration_page_shares_behavior">settings</link>, &smb4k; attempts to unmount either only those shares that are owned by you or all that are listed.</para> - </listitem> - </varlistentry> - </variablelist> - - <para>For each mounted share you can open a submenu that contains the following entries. For further information read <link linkend="shares_view_actions_popup_menu">here</link>.</para> - - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Unmount</guimenuitem></menuchoice> - </term> - <listitem> - <para>Unmount the share.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> - </term> - <listitem> - <para>Add the selected share to the bookmarks.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Synchronize</guimenuitem></menuchoice> - </term> - <listitem> - <para>Synchronize the mounted share with a local copy or vice versa. For further information read <link linkend="shares_view_actions_popup_menu">here</link> and <link linkend="shares_view_synchronization">here</link>.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Open with &konsole;</guimenuitem></menuchoice> - </term> - <listitem> - <para>Open the base folder of the share in &konsole;.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Open with File Manager</guimenuitem></menuchoice> - </term> - <listitem> - <para>Open the contents of the share in the default file manager (⪚ &dolphin;).</para> - </listitem> - </varlistentry> - </variablelist> + <screenshot> + <screeninfo>Screenshot of the system tray widget</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="systemtray_location.png" format="PNG" /></imageobject> + <textobject><phrase>System tray widget</phrase></textobject> + </mediaobject> + </screenshot> - <para>The <guimenuitem>Bookmarks</guimenuitem> menu contains all your bookmarks organized according to the structure you gave them (see also <link linkend="bookmarks_adding">here</link> and <link linkend="bookmarks_editor">here</link>).</para> + <para>By left clicking the icon, you can minimize or restore the main window. A right click brings up a popup menu that contains several menu items allowing you to work with the mounted shares, manage or mount your bookmarks, select the profile you want to use and to configure &smb4k; without the need to open the main window.</para> + </sect2> - <screenshot> - <screeninfo>Screenshot of the Bookmarks menu of the system tray widget</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="systemtray_bookmarks_menu.png" format="PNG" /></imageobject> - <textobject><phrase>System tray widget's Bookmarks menu</phrase></textobject> - </mediaobject> - </screenshot> +<!-- + Using Smb4K : The System Tray Widget : Menus and Menu Items + --> - <para>Its layout is as described <link linkend="bookmarks_menu">here</link> except that the <guimenuitem>Add Bookmark</guimenuitem> menu item is not present.</para> - <para>In the <guimenuitem>Profiles</guimenuitem> menu, all <link linkend="profiles">defined</link> profiles are listed:</para> + <sect2 id="systemtray_menus"> + <title>Menus and Menu Items</title> - <screenshot> - <screeninfo>Screenshot of the Profiles menu of the system tray widget</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="systemtray_profiles_menu.png" format="PNG" /></imageobject> - <textobject><phrase>System tray widget's Profiles menu</phrase></textobject> - </mediaobject> - </screenshot> + <para>The <guimenuitem>Mounted Shares</guimenuitem> menu lists all mounted shares and some actions that can be performed on them.</para> - <para>You can activate a profile by clicking it. The profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_profiles">configuration dialog</link>.</para> - <para>The other menu entries are:</para> + <screenshot> + <screeninfo>Screenshot of the Mounted Shares popup menu of the system tray widget</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="systemtray_mounted_shares_menu.png" format="PNG" /></imageobject> + <textobject><phrase>System tray widget's Mounted Shares menu</phrase></textobject> + </mediaobject> + </screenshot> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice> - </term> - <listitem> - <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for "manual" mounts.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Configure &smb4k;...</guimenuitem></menuchoice> - </term> - <listitem> - <para>Open the configuration dialog. See <link linkend="configuration">here</link> for a full list of available settings.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Minimize | Restore</guimenuitem></menuchoice> - </term> - <listitem> - <para>Hide (minimize) or show (restore) the main window. Which text is shown depends on the state of the main window.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>Q</keycap></keycombo></shortcut><guimenuitem>Quit</guimenuitem></menuchoice> - </term> - <listitem> - <para>Quit the application.</para> - </listitem> - </varlistentry> - </variablelist> - </sect2> -</sect1> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Unmount All</guimenuitem></menuchoice> + </term> + <listitem> + <para>Unmount all shares at once. Depending on your <link linkend="configuration_page_shares_behavior">settings</link>, &smb4k; attempts to unmount either only those shares that are owned by you or all that are listed.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>For each mounted share you can open a submenu that contains the following entries. For further information read <link linkend="shares_view_actions_popup_menu">here</link>.</para> + + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Unmount</guimenuitem></menuchoice> + </term> + <listitem> + <para>Unmount the share.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> + </term> + <listitem> + <para>Add the selected share to the bookmarks.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Synchronize</guimenuitem></menuchoice> + </term> + <listitem> + <para>Synchronize the mounted share with a local copy or vice versa. For further information read <link linkend="shares_view_actions_popup_menu">here</link> and <link linkend="shares_view_synchronization">here</link>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Open with &konsole;</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the base folder of the share in &konsole;.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Open with File Manager</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the contents of the share in the default file manager (⪚ &dolphin;).</para> + </listitem> + </varlistentry> + </variablelist> + + <para>The <guimenuitem>Bookmarks</guimenuitem> menu contains all your bookmarks organized according to the structure you gave them (see also <link linkend="bookmarks_adding">here</link> and <link linkend="bookmarks_editor">here</link>).</para> + + <screenshot> + <screeninfo>Screenshot of the Bookmarks menu of the system tray widget</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="systemtray_bookmarks_menu.png" format="PNG" /></imageobject> + <textobject><phrase>System tray widget's Bookmarks menu</phrase></textobject> + </mediaobject> + </screenshot> + + <para>Its layout is as described <link linkend="bookmarks_menu">here</link> except that the <guimenuitem>Add Bookmark</guimenuitem> menu item is not present.</para> + <para>In the <guimenuitem>Profiles</guimenuitem> menu, all <link linkend="profiles">defined</link> profiles are listed:</para> + + <screenshot> + <screeninfo>Screenshot of the Profiles menu of the system tray widget</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="systemtray_profiles_menu.png" format="PNG" /></imageobject> + <textobject><phrase>System tray widget's Profiles menu</phrase></textobject> + </mediaobject> + </screenshot> + + <para>You can activate a profile by clicking it. The profiles can be <link linkend="profiles">managed</link> via the <link linkend="configuration_profiles">configuration dialog</link>.</para> + <para>The other menu entries are:</para> + + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Open Mount Dialog</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the <link linkend="network_neighborhood_browser_mounting">dialog</link> for "manual" mounts.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Configure &smb4k;...</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the configuration dialog. See <link linkend="configuration">here</link> for a full list of available settings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Minimize | Restore</guimenuitem></menuchoice> + </term> + <listitem> + <para>Hide (minimize) or show (restore) the main window. Which text is shown depends on the state of the main window.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><shortcut><keycombo action="simul">&Ctrl; <keycap>Q</keycap></keycombo></shortcut><guimenuitem>Quit</guimenuitem></menuchoice> + </term> + <listitem> + <para>Quit the application.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> <!-- Using Smb4K : The Plasmoid @@ -1172,146 +1164,157 @@ <!-- Using Smb4K : Bookmarks ---> + --> -<sect1 id="bookmarks"> - <title>Bookmarks</title> + <sect1 id="bookmarks"> + <title>Bookmarks</title> <!-- - Using Bookmarks : Adding Bookmarks ---> + Using Smb4K : Bookmarks : Adding Bookmarks + --> - <sect2 id="bookmarks_adding"> - <title>Adding Bookmarks</title> + <sect2 id="bookmarks_adding"> + <title>Adding Bookmarks</title> - <para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link><!-- Remove the following in favor of the commented part --> and the <link linkend="shares_view">shares view</link><!--, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>-->. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. <!--In the &plasmoid;, you click the respective bookmark action next to the item's name.--> A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> + <para>You can add bookmarks to your favorite shares from within the <link linkend="network_neighborhood_browser">network neighborhood browser</link><!-- Remove the following in favor of the commented part --> and the <link linkend="shares_view">shares view</link><!--, the <link linkend="shares_view">shares view</link> and the <link linkend="plasmoid">&plasmoid;</link>-->. In the dock widgets of the main window, this is done by selecting one or multiple shares and clicking the <menuchoice><guimenuitem>Add Bookmark</guimenuitem></menuchoice> action. <!--In the &plasmoid;, you click the respective bookmark action next to the item's name.--> A dialog will then pop up where you can add a label and/or assign a group to the bookmark.</para> - <screenshot> - <screeninfo>Screenshot of the bookmarks addition dialog</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="bookmarks_add_bookmark_dialog.png" format="PNG" /></imageobject> - <textobject><phrase>Bookmarks addition dialog</phrase></textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Screenshot of the bookmarks addition dialog</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="bookmarks_add_bookmark_dialog.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmarks addition dialog</phrase></textobject> + </mediaobject> + </screenshot> - <para>Especially adding a group may help you to organize the bookmarks. In the bookmark menu, all bookmarks belonging to one group will be arranged in a submenu with the group entry as parent (see <link linkend="bookmarks_menu">below</link>).</para> - <para>The label can be any text describing the share. In case you define a label, it will be displayed in the bookmarks menu instead of the UNC by default. If you want to change this behavior, you can do so in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>.</para> - </sect2> + <para>Especially adding a group may help you to organize the bookmarks. In the bookmark menu, all bookmarks belonging to one group will be arranged in a submenu with the group entry as parent (see <link linkend="bookmarks_menu">below</link>).</para> + <para>The label can be any text describing the share. In case you define a label, it will be displayed in the bookmarks menu instead of the UNC by default. If you want to change this behavior, you can do so in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>.</para> + </sect2> + +<!-- + Using Smb4K : Bookmarks : Accessing and Managing Bookmarks + --> - <sect2 id="bookmarks_menu"> - <title>Accessing and Managing Bookmarks</title> + <sect2 id="bookmarks_menu"> + <title>Accessing and Managing Bookmarks</title> - <para>In the main window, the bookmarks can be accessed and managed through the <guilabel>Bookmarks</guilabel> menu:</para> + <para>In the main window, the bookmarks can be accessed and managed through the <guilabel>Bookmarks</guilabel> menu:</para> - <screenshot> - <screeninfo>Screenshot of the bookmark popup menu</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="bookmarks_popup_menu.png" format="PNG" /></imageobject> - <textobject><phrase>Bookmark popup menu</phrase></textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Screenshot of the bookmark popup menu</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="bookmarks_popup_menu.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmark popup menu</phrase></textobject> + </mediaobject> + </screenshot> - <para>In the menu there are two static items available:</para> + <para>In the menu there are two static items available:</para> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice> - </term> - <listitem> - <para>Open the <link linkend="bookmarks_editor">bookmark editor</link>. This action is disabled if there are no bookmarks.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice> - <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut> - <guimenuitem>Add Bookmark</guimenuitem> - </menuchoice> - </term> - <listitem> - <para>Add a bookmark. A share has to be selected to enable this action.</para> - </listitem> - </varlistentry> - </variablelist> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Open the <link linkend="bookmarks_editor">bookmark editor</link>. This action is disabled if there are no bookmarks.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice> + <shortcut><keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo></shortcut> + <guimenuitem>Add Bookmark</guimenuitem> + </menuchoice> + </term> + <listitem> + <para>Add a bookmark. A share has to be selected to enable this action.</para> + </listitem> + </varlistentry> + </variablelist> - <para>In case you have not defined any groups, there is a third item:</para> + <para>In case you have not defined any groups, there is a third item:</para> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Mount All Bookmarks</guimenuitem></menuchoice> - </term> - <listitem> - <para>Mount all top-level bookmarks at once. It is disabled if all bookmarked shares are mounted.</para> - </listitem> - </varlistentry> - </variablelist> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Mount All Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Mount all top-level bookmarks at once. It is disabled if all bookmarked shares are mounted.</para> + </listitem> + </varlistentry> + </variablelist> - <para>All other entries are either group submenus or shares that do not belong to a group. All entries are listed alphabetically and the bookmarks may either appear with their UNC address or descriptive label. By clicking a bookmark, the respective share is mounted. If a bookmarked share is mounted on the system, the bookmark entry is disabled.</para> - <para>For each group there is a submenu. It contains all bookmarks belonging to the group and a <guimenuitem>Mount All Bookmarks</guimenuitem> menu item. The latter one can be used to mount all bookmarks in that submenu at once.</para> - <para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. <!--The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu.--> The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="bookmarks_editor">bookmark editor</link>.</para> - </sect2> + <para>All other entries are either group submenus or shares that do not belong to a group. All entries are listed alphabetically and the bookmarks may either appear with their UNC address or descriptive label. By clicking a bookmark, the respective share is mounted. If a bookmarked share is mounted on the system, the bookmark entry is disabled.</para> + <para>For each group there is a submenu. It contains all bookmarks belonging to the group and a <guimenuitem>Mount All Bookmarks</guimenuitem> menu item. The latter one can be used to mount all bookmarks in that submenu at once.</para> + <para>In the system tray widget, there is an identical <guilabel>Bookmarks</guilabel> <link linkend="systemtray_menus">submenu</link> except that the <guilabel>Add Bookmark</guilabel> entry is missing. <!--The plasmoid provides a <guilabel>Bookmarks</guilabel> <link linkend="plasmoid_bookmarks">tab</link> where all bookmarks are arranged in a similar way as in the bookmark menu.--> The bookmark groups and the bookmarks are listed in the view. Bookmarked shares can be mounted by clicking the respective entry. In the tool bar two actions are present: <guimenuitem>Back</guimenuitem> and <guimenuitem>Edit</guimenuitem>. By clicking <guimenuitem>Back</guimenuitem> you can get back to the top level if you entered a group folder. The <guimenuitem>Edit</guimenuitem> action will open the <link linkend="bookmarks_editor">bookmark editor</link>.</para> + </sect2> + +<!-- + Using Smb4K : Bookmarks : Editing Bookmarks + --> - <sect2 id="bookmarks_editor"> - <title>Editing Bookmarks</title> + <sect2 id="bookmarks_editor"> + <title>Editing Bookmarks</title> - <para>The bookmarks may be edited or removed via the bookmark editor. It can be opened by clicking the <guimenuitem>Edit Bookmarks</guimenuitem> entry in the <guilabel>Bookmarks</guilabel> menu or the <guimenuitem>Edit</guimenuitem> action in the <guilabel>Bookmarks</guilabel> tab of the &plasmoid;.</para> - - <screenshot> - <screeninfo>Screenshot of the bookmark editor</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="bookmarks_editor.png" format="PNG" /></imageobject> - <textobject><phrase>Bookmark editor</phrase></textobject> - </mediaobject> - </screenshot> + <para>The bookmarks may be edited or removed via the bookmark editor. It can be opened by clicking the <guimenuitem>Edit Bookmarks</guimenuitem> entry in the <guilabel>Bookmarks</guilabel> menu or the <guimenuitem>Edit</guimenuitem> action in the <guilabel>Bookmarks</guilabel> tab of the &plasmoid;.</para> + + <screenshot> + <screeninfo>Screenshot of the bookmark editor</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="bookmarks_editor.png" format="PNG" /></imageobject> + <textobject><phrase>Bookmark editor</phrase></textobject> + </mediaobject> + </screenshot> - <para>In the tree view, the bookmarks are arranged according to the groups they belong to. Bookmarks without groups are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so that you can move bookmarks around using the mouse.</para> - <para>If you want to edit a bookmark, you can do so by selecting it. The stored label, login, IP address and group name appear in the input widgets and become editable. In most cases, you do not need to touch the IP address and the login, because &smb4k; stored the correct values at the time you bookmarked the share. However, if the server got a different IP address (⪚ because DHCP is used on your local network) or your login changed, these entries should be adjusted. With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the UNC address, but this can be changed in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>. The group entry, finally, helps you to organize your bookmarks. Especially if you use ⪚ your notebook at home and at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two groups "Home" and "Work" and save the bookmarks accordingly.</para> - <para>The tree view also offers a popup menu containing the following three actions. They can be used to add groups or remove groups and/or bookmarks.</para> + <para>In the tree view, the bookmarks are arranged according to the groups they belong to. Bookmarks without groups are located at the top level. To rearrange bookmarks, the tree view offers drag and drop capabilities, so that you can move bookmarks around using the mouse.</para> + <para>If you want to edit a bookmark, you can do so by selecting it. The stored label, login, IP address and group name appear in the input widgets and become editable. In most cases, you do not need to touch the IP address and the login, because &smb4k; stored the correct values at the time you bookmarked the share. However, if the server got a different IP address (⪚ because DHCP is used on your local network) or your login changed, these entries should be adjusted. With the label you can give each bookmark a custom description. It will be used for display <emphasis>instead</emphasis> of the UNC address, but this can be changed in the <link linkend="configuration_user_interface_misc_bookmarks">configuration dialog</link>. The group entry, finally, helps you to organize your bookmarks. Especially if you use ⪚ your notebook at home and at work, and you do not want to use <link linkend="profiles">profiles</link>, it might be a good idea to create two groups "Home" and "Work" and save the bookmarks accordingly.</para> + <para>The tree view also offers a popup menu containing the following three actions. They can be used to add groups or remove groups and/or bookmarks.</para> - <screenshot> - <screeninfo>Screenshot of the popup menu of the bookmark editor</screeninfo> - <mediaobject> - <imageobject><imagedata fileref="bookmarks_editor_popup_menu.png" format="PNG" /></imageobject> - <textobject><phrase>Popup menu of the bookmark editor</phrase></textobject> - </mediaobject> - </screenshot> + <screenshot> + <screeninfo>Screenshot of the popup menu of the bookmark editor</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="bookmarks_editor_popup_menu.png" format="PNG" /></imageobject> + <textobject><phrase>Popup menu of the bookmark editor</phrase></textobject> + </mediaobject> + </screenshot> - <variablelist> - <varlistentry> - <term> - <menuchoice><guimenuitem>Add Group</guimenuitem></menuchoice> - </term> - <listitem> - <para>Add a bookmark group. After you created a group, you can move bookmarks to it.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Remove</guimenuitem></menuchoice> - </term> - <listitem> - <para>Remove a selected bookmark or group. In case of a group, all bookmarks stored under that group are also removed.</para> - </listitem> - </varlistentry> - <varlistentry> - <term> - <menuchoice><guimenuitem>Clear Bookmarks</guimenuitem></menuchoice> - </term> - <listitem> - <para>Remove all bookmarks from the tree view including all groups.</para> - </listitem> - </varlistentry> - </variablelist> - <para>After you finished editing, the changes can be committed by clicking the <guibutton>OK</guibutton> button.</para> - </sect2> -</sect1> + <variablelist> + <varlistentry> + <term> + <menuchoice><guimenuitem>Add Group</guimenuitem></menuchoice> + </term> + <listitem> + <para>Add a bookmark group. After you created a group, you can move bookmarks to it.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Remove</guimenuitem></menuchoice> + </term> + <listitem> + <para>Remove a selected bookmark or group. In case of a group, all bookmarks stored under that group are also removed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <menuchoice><guimenuitem>Clear Bookmarks</guimenuitem></menuchoice> + </term> + <listitem> + <para>Remove all bookmarks from the tree view including all groups.</para> + </listitem> + </varlistentry> + </variablelist> + <para>After you finished editing, the changes can be committed by clicking the <guibutton>OK</guibutton> button.</para> + </sect2> + </sect1> -<!-- Using Smb4K : Profiles --> +<!-- + 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> @@ -1325,7 +1328,7 @@ <screeninfo>Screenshot of the Profiles configuration page (add profile)</screeninfo> <mediaobject> <imageobject> - <imagedata fileref="configuration_profiles_add_profile.png" format="PNG" /> + <imagedata fileref="configuration_page_profiles_add_profile.png" format="PNG" /> </imageobject> <textobject> <phrase>Profiles configuration page (add profile)</phrase> @@ -1459,12 +1462,12 @@ client ipc max protocol = NT1 <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> + <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.*"> diff --git a/doc/notification_missing_program.png b/doc/notification_missing_program.png new file mode 100644 index 0000000..8dc98e6 Binary files /dev/null and b/doc/notification_missing_program.png differ diff --git a/doc/notification_program_missing.png b/doc/notification_program_missing.png deleted file mode 100644 index 9f6acd6..0000000 Binary files a/doc/notification_program_missing.png and /dev/null differ
