Differences
This shows you the differences between the selected revisions of the page.
| ui_queue 2005-02-09 | ui_queue 2023-02-16 (current) | ||
| Line 1: | Line 1: | ||
| ====== Background Transfers Queue List ====== | ====== Background Transfers Queue List ====== | ||
| - | On both interfaces there is optional component at the very bottom, queue list of [[transfer_queue|background transfers]]. To show/hide the list use main menu (//View > Queue// in [[ui_explorer|Explorer-like interface]], | + | 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]], |
| - | //Options > Queue// in [[ui_commander|Norton Commander interface]]). Queue list have special view state //Hide when Empty//. This is 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 transfer in progress or scheduled, only. |
| - | ===== Information Displayed in the Queue List ===== | + | &screenshotpict(queue_list) |
| - | Each entry in the queue list represents one [[transfer_queue|background transfer]] (not file to transfer). The entries on the top of the queue represent transfers in progress. Each transfer in progress has two lines, where the second line is used to display information about file being transfered. | + | ===== [[information]] Information Displayed in the Queue List ===== |
| - | Information beings shown in the first line is following: | + | Each entry in the queue list represents one [[transfer_queue|background transfer]] (not a file to transfer). |
| + | |||
| + | There are three groups of transfers 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]]. | ||
| + | * 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. | ||
| + | * Waiting transfers 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 [[ui_queue#interacting_with_background_transfers|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. 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. | |
| - | | //Source// | Path to file if one file only is being transfered. Path to source directory is multiple files are being transfered. | | + | | //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. | | + | | //Destination// | Destination directory of the transfer including [[operation_mask|operation mask]]. | |
| - | | //Transfered// | Total number of bytes already transfered (for all files). Empty for waiting transfers. | | + | | //Transferred// | Total number of bytes already transferred (for all files). Empty for waiting transfers. | |
| - | | //Elapsed// ····| Total time already spent on transfer. 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. | |
| - | | //Progress// | Status of transfer. Percentage indicator for ongoing transfers. //Query//, //Error// or //Prompt// for transfers that need [[ui_queue#interacting_with_background_transfers|interaction with the user]]. //Waiting...// for waiting transfers. | | + | | //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. | |
| - | For ongoing transfers information beings shown in the second line is following: | + | For ongoing transfers information being shown in the other lines is following: |
| ^ Column ^ Description ^ | ^ Column ^ Description ^ | ||
| - | | //Operation// | ·None. | | + | | //Operation// | None. | |
| - | | //Source// | Path to file being transfered. | | + | | //Source// | Path to file being transferred. | |
| | //Destination// | Empty. | | | //Destination// | Empty. | | ||
| - | | //Transfered// | Number of bytes transfered for current file. | | + | | //Transferred// | Number of bytes transferred for current file. | |
| | //Speed// | Average speed of the transfer. | | | //Speed// | Average speed of the transfer. | | ||
| | //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 with Background Transfers ===== | + | ===== [[interacting]] Interacting with Background Transfers ===== |
| - | Sometime the background transfer needs to interact with the user. For example to confirm resuming the files transfer, to show error message or to ask for password. | + | 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. |
| - | There are two interaction modes. In the default mode the message or input box pops up whenever any of the background transfer needs to interact (but only when the main connection is idle). Alternativelly the box may not pop up automatically. Instead the respective line on queue list may visually indicate that the transfer needs interaction. User must double-click the line or choose respective command from queue [[ui_context_menu|context menu]] (or toolbar) to make the box pop up (see [[ui_queue#managing_the_queue|Managing the Queue]]). To switch to alternative mode uncheck //Automatically popup prompts of background transfers when idle// on //Background tab// 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 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. |
| - | Some prompts of background transfers may be avoided at all. To disable overwrite confirmations (and similar prompts) check //No confirmations// on [[&screenshotimg(copy)|transfer options dialog]]. To avoid background transfers asking for password you may instruct WinSCP to save the main session password and reuse it for background transfer connections. Use //Remember password of main session for background transfers// on //Background tab// of Preferences dialog. Note that for this WinSCP must keep the password in memory, what may have security implications. If you have the password saved in [[ui_login_stored_sessions|stored session]], what is not recommended at all, the saved password is used automatically for background transfers. | + | 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. |
| - | ===== 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-like interface]], | + | 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]], |
| - | //Options > Queue > Toolbar// in [[ui_commander|Norton Commander interface]]). | + | //Options > Queue > Toolbar// in [[ui_commander|Commander interface]]. |
| Commands available in the menu (or on the toolbar) are: | Commands available in the menu (or on the toolbar) are: | ||
| ^ Command ^ Description ^ | ^ Command ^ Description ^ | ||
| - | | //Show query/error/prompt// | Available for ongoing transfers only that needs to [[ui_queue#interacting_with_background_transfers|interact with the user]]. | | + | | //Show query/error/prompt// | Available for ongoing transfers 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 maximal background transfers count limit. | | + | | //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]]. | |
| - | | //Delete// | Remove waiting transfer from queue or abort ongoing transfer. | | + | | //Suspend// | Available for ongoing transfers only. Use to temporarily suspend the transfer (e.g. to free bandwidth). | |
| - | | //Move up/down// | Available for waiting transfers only. Use to change priority/order of the waiting transfers | | + | | //Resume// | Available for suspended transfers only. Use to resume suspended transfer. | |
| + | | //Cancel// | Remove waiting transfer from queue or abort ongoing transfer. Keyboard shortcut is ''Del''. | | ||
| + | | //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. | | ||
| + | | //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: | ||
| + | |||
| + | ^ Command ^ Description ^ | ||
| + | | //Suspend All// | Use to temporarily suspend all ongoing transfers. | | ||
| + | | //Resume All// | Use to resume all suspended transfers. | | ||
| + | | //Cancel All// | Use to remove all waiting transfers and abort all ongoing transfers. | | ||
| + | | //Delete All Completed// | Use to remove all completed transfers. Particularly useful, when completed transfers 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.). | ||
| + | |||
| + | ===== [[file_list]] File List ===== | ||
| + | |||
| + | You can display a complete list of files included in a queued transfer. To show the list go to //View > Queue > File List// in [[ui_explorer|Explorer interface]], | ||
| + | //Options > Queue > File List// in [[ui_commander|Commander interface]]). The option is also available in the queue context menu. | ||
| + | |||
| + | The files there were already transferred (or skipped) or are currently being transferred are displayed in a gray color. | ||