Differences
This shows you the differences between the selected revisions of the page.
| ui_pref_commands 2013-05-15 | ui_pref_commands 2023-03-30 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== Commands Page (Preferences Dialog) ====== | + | ====== The Commands Page (Preferences Dialog) ====== |
| - | The //Commands page// on the [[ui_preferences|Preferences dialog]] allows you to configure [[custom_command|custom commands]]. | + | The //Commands page// on the [[ui_preferences|Preferences dialog]] allows you to configure [[custom_command|custom commands]] and manage [[extension|WinSCP extensions]]. |
| &screenshotpict(pref_commands) | &screenshotpict(pref_commands) | ||
| - | The list in the upper part of the page shows configured [[custom_command|custom commands]] in the same order as they will appear in //File(s) > Custom Commands// menu. Initially this will be set of example commands. | + | The list in the upper part of the page shows configured [[custom_command|custom commands]], followed by installed [[extension|extensions]]. The command and extensions display in the same order as they will appear in //Files > Custom Commands// menu. The commands and extensions are separated by a horizontal line. Initially the list will contains a set of example commands and the official extensions. |
| - | Column //Description// shows name of the command as will appear in //File(s) > Custom Commands// menu. Column //Command// show the command itself. Column //L/R// shows ''L'' for local commands or ''R'' for remote commands. Column //D/R// shows ''D'', when command is to be executed for directories, and ''R'' for recursive commands (or any combination). | + | The //Description// column shows a name of the command/extension as will appear in //Files > Custom Commands// menu. The //Command// column show the command itself. The //L/R// column shows ''L'' for local commands or ''R'' for remote commands. |
| - | Use button //Add// to add new custom command. //[[ui_customcommand|Custom command editor dialog]]// will appear. The newly added command will be inserted before a command selected in the list or at the end, if no command is selected. | + | Hovering a mouse cursor over the command/extension displays a hint with additional information. For extensions, it particularly shows a [[extension#loading|path to an extension file]]. |
| - | Use button //Edit// to edit selected custom command. //[[ui_customcommand|Custom command editor dialog]]// will appear. | + | ===== Configuring Custom Command ===== |
| - | Use button //Remove// to remove selected custom command. If you remove command by mistake, you can always cancel whole Preferences dialog to undo all changes. | + | Use the //Add > Add Custom Command// to add a new custom command. The //[[ui_customcommand|Custom command editor dialog]]// will appear. The newly added command will be inserted before a command selected in the list or at the end, if no command is selected. |
| - | Use buttons //Up// and //Down// to change order of the commands. | + | Use the //Edit// button to edit the selected custom command. The //[[ui_customcommand|Custom command editor dialog]]// will appear. |
| + | |||
| + | Use the //Remove// button to remove the selected custom command. If you remove command by mistake, you can always cancel whole Preferences dialog to undo all changes. | ||
| + | |||
| + | ===== [[extensions]] Managing Extensions ===== | ||
| + | |||
| + | Use the //Add > Add Extension// to install a new extension. The //Add Extension// prompt displays. Enter a URL to download an extension file from; or a path to a local extension file. The extension file will be validated and installed to the [[extension#loading|WinSCP application data folder]]. | ||
| + | |||
| + | Use the //Remove// button to remove the selected extension. When the selected extension is an official extension,((In general, if the current user does not have permissions to delete the extension file. What is typical for the official extensions as these are installed to the ''Program Files'' folder.)) the extension is just hidden (its extension file stays). To restore a hidden extension, you have to locate its extension file (e.g. ''C:\Program Files (x86)\WinSCP\Extensions\SearchText.WinSCPextension.ps1'') and use the //Add > Add Extension// to re-add it. When the selected extension is a user-installed extension, its extension file is removed along. | ||
| + | |||
| + | Use the //==Configure==// button to configure the selected extension. Each extension can have its own set of [[extension#options|configuration options]] (or none at all). For all extensions it is possible to configure a [[custom_key_shortcuts|custom keyboard shortcut]]. | ||
| + | |||
| + | ===== Ordering Commands/Extensions ===== | ||
| + | |||
| + | Use the //Up// and //Down// buttons to change order of the commands and extensions. | ||
| + | |||
| + | You cannot mix commands and extensions. | ||
| ===== Further Reading ===== | ===== Further Reading ===== | ||
| Read more about [[ui_preferences|Preferences dialog]] and its other [[ui_preferences#pages|pages]]. | Read more about [[ui_preferences|Preferences dialog]] and its other [[ui_preferences#pages|pages]]. | ||