Differences
This shows you the differences between the selected revisions of the page.
| 2023-02-16 | 2025-01-28 (current) | ||
| task_connection#switch => ui_tabs#switch (martin) | not about transfers only for a while already (martin) | ||
| Line 1: | Line 1: | ||
| - | ====== Background Transfers Queue List ====== | + | ====== Background Operations Queue List ====== |
| - | On both interfaces there is an optional component at the very bottom, queue list of [[transfer_queue|background transfers]]. To show/hide the list use the main menu (//View > Queue// in [[ui_explorer|Explorer interface]], | + | On both interfaces there is an optional component at the very bottom, queue list of [[transfer_queue|background operations]]. To show/hide the list use the main menu (//View > Queue// in [[ui_explorer|Explorer interface]], |
| - | //Options > Queue// in [[ui_commander|Commander interface]]). The queue list have special view state //Hide when Empty//. This is the default state and makes the queue list visible, when there is some background transfer in progress or scheduled, only. | + | //Options > Queue// in [[ui_commander|Commander interface]]). The queue list have special view state //Hide when Empty//. This is the default state and makes the queue list visible, when there is some background operation in progress or scheduled, only. |
| &screenshotpict(queue_list) | &screenshotpict(queue_list) | ||
| Line 7: | Line 7: | ||
| ===== [[information]] Information Displayed in the Queue List ===== | ===== [[information]] Information Displayed in the Queue List ===== | ||
| - | Each entry in the queue list represents one [[transfer_queue|background transfer]] (not a file to transfer). | + | Each entry in the queue list represents one [[transfer_queue|background operation]] (not one file). |
| - | There are three groups of transfers in the following order: | + | There are three groups of operations in the following order: |
| - | * Completed transfers are optionally shown first in gray color. You can configure the period they show or turn them off completely in [[ui_pref_background|preferences]]. You can also [[#manage|delete all completed transfers manually]]. | + | * Completed operations are optionally shown first in gray color. You can configure the period they show or turn them off completely in [[ui_pref_background|preferences]]. You can also [[#manage|delete all completed operations manually]]. |
| - | * Transfers in progress show second. Each multi-file (batch) transfer in progress has two or more lines, where the first line shows overall batch progress, while the others lines are used to display information about files being transferred. | + | * Operations in progress show second. Each multi-file (batch) transfer in progress has two or more lines, where the first line shows overall batch progress, while the others lines are used to display information about files being transferred. |
| - | * Waiting transfers show last. | + | * Waiting operations show last. |
| ^ Column ^ Description ^ | ^ Column ^ Description ^ | ||
| - | | //Operation// | Icon representing the operation. Right-to-left arrow for downloads, Left-to-right icon for uploads. If the background transfer needs [[#interacting|interaction with the user]], there is an additional icon representing the type of interaction (confirmation, error message or prompt) and both icons flash. | | + | | //Operation// | Icon representing the operation. Right-to-left arrow for downloads, Left-to-right icon for uploads, Cross for deletes. If the background operations needs [[#interacting|interaction with the user]], there is an additional icon representing the type of interaction (confirmation, error message or prompt) and both icons flash. | |
| | //Source// | Path to file if one file only is being transferred. Path to source directory if multiple files are being transferred. | | | //Source// | Path to file if one file only is being transferred. Path to source directory if multiple files are being transferred. | | ||
| | //Destination// | Destination directory of the transfer including [[operation_mask|operation mask]]. | | | //Destination// | Destination directory of the transfer including [[operation_mask|operation mask]]. | | ||
| | //Transferred// | Total number of bytes already transferred (for all files). Empty for waiting transfers. | | | //Transferred// | Total number of bytes already transferred (for all files). Empty for waiting transfers. | | ||
| - | | //Time// | Estimated time till end of transfer.((Estimated time is shown only when no directory was selected for transfers or when transfer setting //[[ui_transfer_custom|Calculate total size]]// is enabled. Total time already spent on transfer is shown otherwise.)) Empty for waiting transfers. | | + | | //Time// | Estimated time till end of operation.((Estimated time is shown only for transfers, when no directory was selected for transfer or when transfer setting //[[ui_transfer_custom|Calculate total size]]// is enabled. Total time already spent on operation is shown otherwise.)) Empty for waiting operations. | |
| - | | //Progress// | Status of transfer. Percentage indicator for ongoing transfers. //Query//, //Error// or //Prompt// for transfers that need [[#interacting|interaction with the user]]. //Waiting...// for waiting transfers. //Suspended// for suspended transfers. //Completed// for completed transfers. | | + | | //Progress// | Status of operation. Percentage indicator for ongoing transfers. //Query//, //Error// or //Prompt// for operations that need [[#interacting|interaction with the user]]. //Waiting...// for waiting operations. //Suspended// for suspended operations. //Completed// for completed operations. | |
| For ongoing transfers information being shown in the other lines is following: | For ongoing transfers information being shown in the other lines is following: | ||
| Line 32: | Line 32: | ||
| | //Progress// | The same as in the first line, only the percentage indicator, if shown, is for the current file only. | | | //Progress// | The same as in the first line, only the percentage indicator, if shown, is for the current file only. | | ||
| - | ===== [[interacting]] Interacting with Background Transfers ===== | + | ===== [[interacting]] Interacting with Background Operations ===== |
| - | Sometime the background transfer needs to interact with the user. For example to confirm resuming the files transfer, to show an error message or to ask for a password. | + | Sometime the background operation needs to interact with the user. For example to confirm resuming the file transfer, to show an error message or to ask for a password. |
| - | There are two interaction modes. In the default mode, the message or an input box pops up whenever any of the background transfers need to interact (but only when the main connection is idle). Alternatively the box may not pop up automatically. Instead the respective line on queue list may visually indicate that the transfer needs an interaction. The user must double-click the line or choose a respective command from queue [[ui_context_menu|context menu]] (or toolbar) to make the box pop up (see [[#manage|Managing the Queue]]). To switch to alternative mode uncheck //[[ui_pref_background#background_transfers|Automatically popup prompts of background transfers when idle]]// on //Background page// of Preferences dialog. | + | There are two interaction modes. In the default mode, the message or an input box pops up whenever any of the background operation needs to interact (but only when the main connection is idle). Alternatively the box may not pop up automatically. Instead the respective line on queue list may visually indicate that the operation needs an interaction. The user must double-click the line or choose a respective command from queue [[ui_context_menu|context menu]] (or toolbar) to make the box pop up (see [[#manage|Managing the Queue]]). To switch to alternative mode uncheck //[[ui_pref_background#background_transfers|Automatically popup prompts of background transfers when idle]]// on //Background page// of Preferences dialog. |
| - | Some prompts of background transfers may be avoided altogether. To disable [[ui_overwrite|overwrite confirmations]] (and similar prompts) check //No confirmations// on [[ui_copy|transfer options dialog]]. To avoid background transfers asking for a password, WinSCP [[security_credentials#password_memory|keeps the main session password in memory]] by default and reuses it for background transfer connections. | + | Some prompts of background operations may be avoided altogether. To disable [[ui_overwrite|overwrite confirmations]] (and similar prompts) check //No confirmations// on [[ui_copy|transfer options dialog]]. To avoid background operations asking for a password, WinSCP [[security_credentials#password_memory|keeps the main session password in memory]] by default and reuses it for background operations connections. |
| ===== [[manage]] Managing the Queue ===== | ===== [[manage]] Managing the Queue ===== | ||
| - | You can manage scheduled transfers using [[ui_context_menu|context menu]] of the queue list or using optional toolbar. To show the toolbar go to //View > Queue > Toolbar// in [[ui_explorer|Explorer interface]], | + | You can manage scheduled operations using [[ui_context_menu|context menu]] of the queue list or using optional toolbar. To show the toolbar go to //View > Queue > Toolbar// in [[ui_explorer|Explorer interface]], |
| //Options > Queue > Toolbar// in [[ui_commander|Commander interface]]. | //Options > Queue > Toolbar// in [[ui_commander|Commander interface]]. | ||
| Line 46: | Line 46: | ||
| ^ Command ^ Description ^ | ^ Command ^ Description ^ | ||
| - | | //Show query/error/prompt// | Available for ongoing transfers only that needs to [[#interacting|interact with the user]]. | | + | | //Show query/error/prompt// | Available for ongoing operations only that needs to [[#interacting|interact with the user]]. | |
| - | | //Execute now// | Available for waiting transfers only. Use to instruct WinSCP to allow additional temporary connection for this transfer despite the [[ui_pref_background#background_transfers|maximal background transfers count limit]]. | | + | | //Execute now// | Available for waiting operations only. Use to instruct WinSCP to allow additional temporary connection for this operation despite the [[ui_pref_background#background_transfers|maximal background operations count limit]]. | |
| - | | //Suspend// | Available for ongoing transfers only. Use to temporarily suspend the transfer (e.g. to free bandwidth). | | + | | //Suspend// | Available for ongoing operations only. Use to temporarily suspend the operation (e.g. to free bandwidth). | |
| - | | //Resume// | Available for suspended transfers only. Use to resume suspended transfer. | | + | | //Resume// | Available for suspended operations only. Use to resume suspended operation. | |
| - | | //Cancel// | Remove waiting transfer from queue or abort ongoing transfer. Keyboard shortcut is ''Del''. | | + | | //Cancel// | Remove waiting operation from queue or abort ongoing operation. Keyboard shortcut is ''Del''. | |
| | //Speed// | Limits speed of ongoing transfer. The limit is in KB/s. To remove speed limit, set it to "Unlimited". | | | //Speed// | Limits speed of ongoing transfer. The limit is in KB/s. To remove speed limit, set it to "Unlimited". | | ||
| - | | //Move up/down// | Available for waiting transfers only. Use to change priority/order of the waiting transfers. | | + | | //Move up/down// | Available for waiting operations only. Use to change priority/order of the waiting operations. | |
| | //Process Queue// | Explicitly starts queue processing, if its processing is [[ui_pref_background#background_transfers|disabled by default]]. | | | //Process Queue// | Explicitly starts queue processing, if its processing is [[ui_pref_background#background_transfers|disabled by default]]. | | ||
| - | In submenu //All// you will find additional commands affecting all transfers in particular state: | + | In submenu //All// you will find additional commands affecting all operations in particular state: |
| ^ Command ^ Description ^ | ^ Command ^ Description ^ | ||
| - | | //Suspend All// | Use to temporarily suspend all ongoing transfers. | | + | | //Suspend All// | Use to temporarily suspend all ongoing operations. | |
| - | | //Resume All// | Use to resume all suspended transfers. | | + | | //Resume All// | Use to resume all suspended operations. | |
| - | | //Cancel All// | Use to remove all waiting transfers and abort all ongoing transfers. | | + | | //Cancel All// | Use to remove all waiting operations and abort all ongoing operations. | |
| - | | //Delete All Completed// | Use to remove all completed transfers. Particularly useful, when completed transfers are [[ui_pref_background|configured to show forever]]. | | + | | //Delete All Completed// | Use to remove all completed operations. Particularly useful, when completed operations are [[ui_pref_background|configured to show forever]]. | |
| - | In submenu //Once Empty// or on the queue toolbar you can choose [[once_done|action to do]] once the queue is completed (all scheduled transfers are finished). Note that the action setting is cleared whenever you [[ui_tabs#switch|switch sessions]]. Also the action will not be done, if WinSCP is not idle (i.e. there is some dialog box opened, etc.). | + | In submenu //Once Empty// or on the queue toolbar you can choose [[once_done|action to do]] once the queue is completed (all scheduled operations are finished). Note that the action setting is cleared whenever you [[ui_tabs#switch|switch sessions]]. Also the action will not be done, if WinSCP is not idle (i.e. there is some dialog box opened, etc.). |
| ===== [[file_list]] File List ===== | ===== [[file_list]] File List ===== | ||