From 9c33caf74e8af3abd73d143a80d8b448ec59a72f Mon Sep 17 00:00:00 2001
From: Faryan Rezagholi
- This documentation is written and based on version 1.76 of mRemoteNG. If you find anything to improve or wrong with the documentation then please report it to github.
- Also note that documentation can be found on github pages that are updated more frequently then information provided here.
- This documentation is written and based on version 1.76 of mRemoteNG. If you find anything to improve or wrong with the documentation then please report it to github. Also note that documentation can be found on github pages that are updated more frequently then information provided here.
- mRemoteNG is a multi-protocol remote connections manager.
-
- The application is released under the GPL (V2)
- mRemoteNG is a multi-protocol remote connections manager. The application is released under the GPL (V2)
- The following is a list of command line switches supported by mRemoteNG.
- The following is a list of command line switches supported by mRemoteNG.
- Downloads are provided in four different packages, the setup package, binary package,
- portable package and
- the source package. They are described below.
-
- The setup package is the compiled version of mRemoteNG which comes in an MSI installer.
- The portable package consists of the same files as the bin package but contains
- an modified version of the executable which stores and loads all your settings
- from files in the application's directory.
- The source package is a zip package and contains the source code in form of a
- Visual Studio solution.
-
- mRemoteNG can be updated without uninstalling it before. Downloads are provided in four different packages, the setup package, binary package, portable package and the source package. They are described below. The setup package is the compiled version of mRemoteNG which comes in an MSI installer. The portable package consists of the same files as the bin package but contains an modified version of the executable which stores and loads all your settings from files in the application's directory. The source package is a zip package and contains the source code in form of a Visual Studio solution. mRemoteNG can be updated without uninstalling it before.
- The following updates must be present on any Windows 7 or Server 2008 client that will be
- running mRemoteNG. (They must have been installed in the order provided below):
- The following are suggested (but not required) for Windows 7 / Server 2008 clients: The following updates must be present on any Windows 7 or Server 2008 client that will be running mRemoteNG. (They must have been installed in the order provided below): The following are suggested (but not required) for Windows 7 / Server 2008 clients:
- Here is a quick reference of the interface:
-
- The screenshot above explains the most basic of the interface. To understand it all
- we are creating a small tutorial here.
-
- Right click on the root item (the little blue globe named "Connections") in
- the Connections panel and select "New Connection". Or use the keybinding
- Ctrl+N if the Connections are selected.
-
- A new item shows up under the root item. You can give it a name now
- (or rename it later). Here we just name it "Test".
-
- Now lets look at the Config panel in the bottom left, just under the
- Connections panel.
-
- As you may notice this is where you configure all the properties of connections
- and folders.
- The most important things right now are that we tell the application which host
- we want to connect to and which protocol we want to use.
- The next thing we will do is to fill in the Hostname/IP field with the hostname
- we want to connect to. Lets also fill in a username and password so that we login
- automatically to the server.
-
- Lets now try to connect to the server.
-
- There are multiple ways to open a connection in mRemoteNG, but the easiest
- way is to double click the connection in the Connections panel.
-
- If you double click the connection you will notice that the connection is going
- to try and open in a new panel called General and under a tab
- called Test .
-
- If all goes well you should see the remote desktop without any problems.
-
- To close the connection you can do any of the following:
- Welcome to mRemoteNG
-
-Getting Started
-
-
-User Interface
-
-
-Special Topics
-Connections
-
-
-
+
+
+ Welcome to mRemoteNG
+
+ Getting Started
+
+
+ User Interface
+
+
+ Special Topics
+ Connections
+
+
+
\ No newline at end of file
diff --git a/mRemoteV1/Resources/Help/Introduction.htm b/mRemoteV1/Resources/Help/Introduction.htm
index 38630e69..3986a48a 100644
--- a/mRemoteV1/Resources/Help/Introduction.htm
+++ b/mRemoteV1/Resources/Help/Introduction.htm
@@ -1,50 +1,40 @@
-
+
-
-
- Introduction
-
-
- As of Version 1.00 it supports the RDP, VNC, ICA, SSH, Telnet, RAW, Rlogin and HTTP/S protocols.
-
- The main goal is to minimize window clutter and to provide a easy gui for managing all your remote connections.
-Features
-
-
-
-License
-
-
- Binary and source code packages are available for download.
-Introduction
+
+
As of Version 1.00 it supports the RDP, VNC, ICA, SSH, Telnet, RAW, Rlogin and HTTP/S protocols.
The main goal is to minimize window clutter and to provide a easy gui for managing all your remote connections.Features
+
+
+
+ License
+
+
Binary and source code packages are available for download.
-
-
-
- Command
- Description
-
-
-
- /cons:PathToConnectionsFile
-
-
- /c:PathToConnectionsFile
-
- Loads the connections file from the given path.
-
-
- This path can be a:
-
-
-
-
-
- /reset
-
- Resets window position, panels and toolbars
-
-
-
- /resetpos
-
-
- /rp
- Reset the windows position
-
-
-
- /resetpanels
-
-
- /rpnl
- Resets all panel's positions. Use this if you have troubles with panel layouts
-
-
-
- /resettoolbar
-
-
- /rtbr
- Resets the positions of all toolbars
-
-
-
- /noreconnect
-
-
- /norc
- Temporary disables reconnect to previously opened sessions. Use this if you have problems opening mRemoteNG after you enabled the setting and restarted mRemoteNG
-
+
+
+
+ Command
+ Description
+
+
+
+ /cons:
+ PathToConnectionsFile
+
+
+
+ /c:
+ PathToConnectionsFile
+ Loads the connections file from the given path.
+
+
This path can be a:
+
+
+
+
+ /reset
+
+ Resets window position, panels and toolbars
+
+
+
+ /resetpos
+
+
+
+ /rp
+ Reset the windows position
+
+
+
+ /resetpanels
+
+
+
+ /rpnl
+ Resets all panel's positions. Use this if you have troubles with panel layouts
+
+
+
+ /resettoolbar
+
+
+
+ /rtbr
+ Resets the positions of all toolbars
+
+
+
+ /noreconnect
+
+
+
+ /norc
+ Temporary disables reconnect to previously opened sessions. Use this if you have problems opening mRemoteNG after you enabled the setting and restarted mRemoteNG
+ Information
-Setup Package
-
- The common way to get mRemoteNG up and running
-Portable Package
-
- This package can be used to run mRemoteNG from an USB stick an preserve your
- configuration wherever you go.
-Source Package
-Updating and Uninstalling
-
- For portable version of mRemoteNG stores all user data in same folder as
- mRemoteNG.exe file.
-Information
+ Setup Package
+
+ The common way to get mRemoteNG up and running
+ Portable Package
+
This package can be used to run mRemoteNG from an USB stick an preserve your configuration wherever you go.Source Package
+ Updating and Uninstalling
+
For portable version of mRemoteNG stores all user data in same folder as mRemoteNG.exe file.Supported Operating Systems:
-
-
-
-Prerequisites:
-
-
-
-
-
-
-
-
-
- Windows™ 7/Windows Server 2008 R2 clients (requirements)
-
- Get-HotFix | where {$_.HotFixID -eq "KB2574819" -and $_.HotFixID -eq "KB2592687"}
-
-
-
-
-
-
+
+
+ Supported Operating Systems:
+
+
+
+ Prerequisites:
+
+
+
+
+
+
+
+
+ Windows™ 7/Windows Server 2008 R2 clients (requirements)
+
+
+ Get-HotFix | where {$_.HotFixID -eq "KB2574819" -and $_.HotFixID -eq "KB2592687"}
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mRemoteV1/Resources/Help/gs_running_mremoteng.htm b/mRemoteV1/Resources/Help/gs_running_mremoteng.htm
index 2ca44318..89d7a3c2 100644
--- a/mRemoteV1/Resources/Help/gs_running_mremoteng.htm
+++ b/mRemoteV1/Resources/Help/gs_running_mremoteng.htm
@@ -1,175 +1,85 @@
-
+
-
-
- First Run
-
-
-Creating a connection
-
-
-
-
- There are a lot of values that can be set but for our first connection we will
- keep things simple.
-
- In this example we will use a Windows 2012 R2 server that has RDP (Remote Desktop
- Protocol) enabled.
- As RDP is the default protocol whenever you create a new connection we don't have
- to change anything there.
-
-
-
- This icon does a ICMP ping on to check response from the server. If it glows green
- it indicates a connection response can be made using ping to the host.
- However this is turned off on windows by default. You have to enable ICMP and allow
- the firewall access for it.
-Opening and Closing Connections
-
-
-
-
- Folders on mRemoteNG cannot only be used to categorize connections but also to - apply properties to the underlying connections. -
-- You have 10 Remote Desktop enabled servers in one domain and 15 in another domain. -
-- Normally you would spend a lot of time creating all those connections and setting - the individual properties like username, password, etc. In mRemoteNG there is an - easier way. You just create two folders, one for domain A and one for domain B - and set all properties there. -
-- Then create the Connections and let them inherit every property. The only - properties left to fill on Connection basis are the Connections name and hostname. - Everything else will be inherited from the parent folder. -
-- Here is how you do this: -
-- This can be done with: -
-- Then give it a name and fill all the properties you need (like you did with - the test connection) -
-
-- When you have filled in the settings and values you can either just drag the test - Connection inside the folder or create a new one. -
-
-
- Right now nothing has changed and nothing will be inherited.
- To enable inheritance switch to the inheritance view by clicking the
- dedicated button. (Marked with a red arrow below)
-
-- The properties that show up now are almost the same as before, but you - only select yes or no to enable or disable a inheritance. -
-
-- When no is selected the property will not be inherited, yes indicates - an inherited property. -
-- For this test set Inherit Everything to Yes. -
-- Now if you switch back to the properties view (the button left - of the inheritance button) you should see that not much is left of all - those properties. -
-
-- Only the Name and Hostname/IP properties are left over, everything else will be - inherited from the parent folder. -
-- Of course you can also only let some of the properties be inherited. Just play - around with this a bit and you'll get the hang of it. -
- + + +Here is a quick reference of the interface:
+
+ The screenshot above explains the most basic of the interface. To understand it all we are creating a small tutorial here.
+Right click on the root item (the little blue globe named "Connections") in the Connections panel and select "New Connection". Or use the keybindingCtrl+N if the Connections are selected.
+
+ A new item shows up under the root item. You can give it a name now (or rename it later). Here we just name it "Test".
+
+ Now lets look at the Config panel in the bottom left, just under the Connections panel.
+
+ As you may notice this is where you configure all the properties of connections and folders.
There are a lot of values that can be set but for our first connection we will keep things simple.
The most important things right now are that we tell the application which host we want to connect to and which protocol we want to use.
In this example we will use a Windows 2012 R2 server that has RDP (Remote Desktop Protocol) enabled.
As RDP is the default protocol whenever you create a new connection we don't have to change anything there.
The next thing we will do is to fill in the Hostname/IP field with the hostname we want to connect to. Lets also fill in a username and password so that we login automatically to the server.
+
+ Lets now try to connect to the server.
+There are multiple ways to open a connection in mRemoteNG, but the easiest way is to double click the connection in the Connections panel.
+If you double click the connection you will notice that the connection is going to try and open in a new panel called General and under a tab called Test .
+
+ If all goes well you should see the remote desktop without any problems.
+To close the connection you can do any of the following:
Folders on mRemoteNG cannot only be used to categorize connections but also to apply properties to the underlying connections.
+You have 10 Remote Desktop enabled servers in one domain and 15 in another domain.
+Normally you would spend a lot of time creating all those connections and setting the individual properties like username, password, etc. In mRemoteNG there is an easier way. You just create two folders, one for domain A and one for domain B and set all properties there.
+Then create the Connections and let them inherit every property. The only properties left to fill on Connection basis are the Connections name and hostname. Everything else will be inherited from the parent folder.
+Here is how you do this:
+This can be done with: +
+ Then give it a name and fill all the properties you need (like you did with the test connection)
+
+
+ When you have filled in the settings and values you can either just drag the test Connection inside the folder or create a new one.
+
+ Right now nothing has changed and nothing will be inherited.
To enable inheritance switch to the inheritance view by clicking the dedicated button. (Marked with a red arrow below)
+ The properties that show up now are almost the same as before, but you only select yes or no to enable or disable a inheritance.
+
+ When no is selected the property will not be inherited, yes indicates an inherited property.
+For this test set Inherit Everything to Yes.
+Now if you switch back to the properties view (the button left of the inheritance button) you should see that not much is left of all those properties.
+
+ Only the Name and Hostname/IP properties are left over, everything else will be inherited from the parent folder.
+Of course you can also only let some of the properties be inherited. Just play around with this a bit and you'll get the hang of it.
+ \ No newline at end of file diff --git a/mRemoteV1/Resources/Help/st_common_problems_rdp.htm b/mRemoteV1/Resources/Help/st_common_problems_rdp.htm index 081413b6..d5c18f28 100644 --- a/mRemoteV1/Resources/Help/st_common_problems_rdp.htm +++ b/mRemoteV1/Resources/Help/st_common_problems_rdp.htm @@ -1,69 +1,42 @@ - + - - -- Its hard to make a document on all problems that can occur with connections - but here at least we are trying to list some of the most common problems for RDP - that has been noticed. -
- - -- mRemoteNG uses the Microsoft Terminal Services Client (MSTSC) libraries in order - to make Remote Desktop connections. mRemoteNG has no control over the functionality - changes implemented by Microsoft. -
-- Relevant line of code that shows our - "RDP Client" connection "object": - - private MsRdpClient8NotSafeForScripting _rdpClient; - -
-- Relevant MS documentation for this .NET class: - MsRdpClient8NotSafeForScripting class -
-- Please refer to - Microsoft's documentation - for full details regarding this problem. -
-- Patched clients attempting to connect to Unpatched servers will fail with the following error: -
-
-- The same error will occur with MSTSC directly on a - patched client attempting to connect to an unpatched server. -
-Per the MS documentation, the only ways around this are to:
-
- Its hard to make a document on all problems that can occur with connections but here at least we are trying to list some of the most common problems for RDP that has been noticed.
+ +mRemoteNG uses the Microsoft Terminal Services Client (MSTSC) libraries in order to make Remote Desktop connections. mRemoteNG has no control over the functionality changes implemented by Microsoft.
+Relevant line of code that shows our "RDP Client" connection "object":private MsRdpClient8NotSafeForScripting _rdpClient; +
+Relevant MS documentation for this .NET class:MsRdpClient8NotSafeForScripting class +
+Please refer toMicrosoft's documentationfor full details regarding this problem.
+Patched clients attempting to connect to Unpatched servers will fail with the following error:
+
+ The same error will occur with MSTSC directly on a patched client attempting to connect to an unpatched server.
+Per the MS documentation, the only ways around this are to:
+
+
-- Config dialog to setup the connection specific properties. - This includes inheritance from other items before the item and more. Details below is about - how to work with this dialog to get the most out of connections and configuration. -
-
-
-
- Red - Sort values Categories or Alphabetical.
- Green - Show Properties, Inheritance values
- Blue - Connection icon
- Yellow - Host status (based on ICMP ping)
-
- Sorts the values in properties either by Categories or Alphabetically. -
- Categories sort - Shows values in categories with expanding options.
- Alphabetical sort - Expands everything and shows values in alphabetical order instead
-
- -
-- The icon indicates the visual identifier for the connection. Clicking the icon will let you set a different icon - for the connection. -
-Is a indicator that will glow red or green depending on the status of the host. The status is based on ICMP ping to the host.
-
+ Config dialog to setup the connection specific properties. This includes inheritance from other items before the item and more. Details below is about how to work with this dialog to get the most out of connections and configuration.
+
+
+
+ Red - Sort values Categories or Alphabetical.
+ Green - Show Properties, Inheritance values
+ Blue - Connection icon
+ Yellow - Host status (based on ICMP ping)
Sorts the values in properties either by Categories or Alphabetically.
+ Categories sort - Shows values in categories with expanding options.
+ Alphabetical sort - Expands everything and shows values in alphabetical order instead
+ +
+The icon indicates the visual identifier for the connection. Clicking the icon will let you set a different icon for the connection.
+Is a indicator that will glow red or green depending on the status of the host. The status is based on ICMP ping to the host.
+- The connections dialog is the main collection of all connections that is added to mRemoteNG. This document will - explain the details of the connections dialog. -
- - -
-
-
- Red - New Connection
- Green - New Folder
- Blue - View (Expand/Collapse all folders)
- Yellow - Ascending sort
-
- Creates a new connection item in the connections dialog after where cursor is present. -
-- Creates a new folder in connections dialog after where cursor is present. -
-- Collapses or expands all directories in the connection dialog. Useful when working with - a lot of connections sorted in different directories. -
- - - -- Works like a sort or a refresh to get connection in ascending order. (Descending order is - note supported yet) When you have been moving around in the tree of connections, just click - this item to refresh the list and get everything in ascending ordering. -
- - + + +The connections dialog is the main collection of all connections that is added to mRemoteNG. This document will explain the details of the connections dialog.
+ +
+
+
+ Red - New Connection
+ Green - New Folder
+ Blue - View (Expand/Collapse all folders)
+ Yellow - Ascending sort
Creates a new connection item in the connections dialog after where cursor is present.
+Creates a new folder in connections dialog after where cursor is present.
+Collapses or expands all directories in the connection dialog. Useful when working with a lot of connections sorted in different directories.
+ + +Works like a sort or a refresh to get connection in ascending order. (Descending order is note supported yet) When you have been moving around in the tree of connections, just click this item to refresh the list and get everything in ascending ordering.
+ + \ No newline at end of file diff --git a/mRemoteV1/Resources/Help/ui_external_tools.htm b/mRemoteV1/Resources/Help/ui_external_tools.htm index 3c23bcc8..b557d850 100644 --- a/mRemoteV1/Resources/Help/ui_external_tools.htm +++ b/mRemoteV1/Resources/Help/ui_external_tools.htm @@ -1,254 +1,160 @@ - + - - -
- External Tools can help you get things done that can't be done in mRemoteNG.
- You can for example start a command prompt or launch your favorite FTP tool from within mRemoteNG.
- This wouldn't make much sense by itself because you can already launch your
- applications by using the Windows Start Menu, Quick Launch or whatever you
- prefer to use to start your apps.
-
- But there's more! -
-- In mRemoteNG, you can launch applications and tell them what to do with the use of - arguments (parameters) and variables of the currently selected Connection. - You can, for example, select your home router's SSH Connection entry and do a - traceroute (tracert) on that host. This is much quicker and more powerful than - opening the console and typing "tracert yourhost". -
-- The external tools configuration is stored in %APPDATA%\mRemoteNG\extApps.xml -
-- Variables and arguments can be used to tell the external tool what to do. -
-- This is the list of variables supported by mRemoteNG: -
-- Variables always refer to the currently selected connection. Variable names are case-insensitive. - Variables can be used in both the Filename and Arguments fields. -
-- mRemoteNG will also expand environment variables such as %PATH% and %USERPROFILE%. - If you need to use an environment variable with the same name as an mRemoteNG - variable, use \% instead of %. The most common use of this is for the USERNAME - environment variable. %USERNAME% will be expanded to the username set in the - currently selected connection. \%USERNAME\% will be expanded to the value set in - the USERNAME environment variable. -
-- If you need to send a variable name to a program without mRemoteNG expanding it, - use ^% instead of %. mRemoteNG will remove the caret (^) and leave the rest - unchanged. For example, ^%USERNAME^% will be sent to the program as %USERNAME% - and will not be expanded. -
-- Expanded variables will be escaped using the rules below. There are two levels - of escaping that are done. The first is escaping for standard argument splitting - (C/C++ argv, CommandLineToArgvW, etc). The second is escaping shell - metacharacters for ShellExecute. -
-- To disable - argument splitting escaping for a variable, precede its name with a minus (-) - sign. For example, %-USERFIELD%. -
-- To disable both argument splitting and shell metacharacter escaping for a - variable, precede its name with an exclamation point (!). For example, - %!USERFIELD%. This is not recommended and may cause unexpected results. -
-- Only variables that have been expanded will be escaped. It is up to you to - escape the rest of the arguments. -
- -| Arguments | -User Field | -Result | -
|---|---|---|
| %USERFIELD% | -"Example" Text | -\^"Example\^" Text | -
| %-USERFIELD% | -"Example" Text | -^"Example^" Text | -
| %!USERFIELD% | -"Example" Text | -"Example" Text | -
| ^%USERFIELD^% | -"Example" Text | -%USERFIELD% | -
| ^^%USERFIELD^^% | -"Example" Text | -^%USERFIELD^% | -
| -d "%USERFIELD%" | -c:\Example\ | --d "c:\Example\\" | -
| -d "%-USERFIELD%" | -c:\Example\ | --d "c:\Example\" | -
| -d "%USERFIELD%" | -Left & Right | --d "Left ^& Right" | -
| -d "%!USERFIELD%" | -Left & Right | --d "Left & Right" | -
| %WINDIR% | N/A | c:\Windows\ | -
| \%WINDIR\% | N/A | c:\Windows\ | -
| \^%WINDIR\^% | N/A | \%WINDIR\% | -
| \\%WINDIR\\% | N/A | \\%WINDIR\\% | -
- First of all, start the external tools editor. To do this, click Tools in the main menu and
- select External Tools.
- You will see a screen like on the following screenshot.
-
-
-
- The fields below the list are greyed out because you haven't created an external tool
- entry yet.
- To create one, right click the blank area in the list and select Add, as in the
- screenshot below.
-
-
-
- This is what you'll get: -
-
-
-
- So the three fields are now available and need to be filled.
- The Display Name is simply the name you will see when you want to launch that
- tool, so give it a descriptive name.
- I named mine Traceroute as I will create a external tool that will start the
- tracert command in the console.
-
-
-
- Ok, the next thing we'll need is a filename. This is the program that we
- want to be executed.
- I simply type in cmd for a Windows cmd console.
-
-
-
- Now the fun part comes in—the arguments.
- The Windows cmd has a command line argument that tells the console to launch the
- command followed by that argument and stay open.
- It's /K. (There's also /C, this is useful when you want the console to close
- after the command was executed)
- In this case, I'll use /K as I want to look through the result when the command
- completes.
- After that, I just type tracert %HostName%. This tells the console to do a
- traceroute on the hostname of the currently selected Connection.
-
-
-
- Alright! That's all we'll need.
- Now right click one of you connections, click Tools, External Tools
- and select Traceroute.
-
-
-
- Voilà ! A console window will popup and execute your tracert command. -
-
-
-
External Tools can help you get things done that can't be done in mRemoteNG.
You can for example start a command prompt or launch your favorite FTP tool from within mRemoteNG.
This wouldn't make much sense by itself because you can already launch your applications by using the Windows Start Menu, Quick Launch or whatever you prefer to use to start your apps.
But there's more!
+In mRemoteNG, you can launch applications and tell them what to do with the use of arguments (parameters) and variables of the currently selected Connection. You can, for example, select your home router's SSH Connection entry and do a traceroute (tracert) on that host. This is much quicker and more powerful than opening the console and typing "tracert yourhost".
+The external tools configuration is stored in %APPDATA%\mRemoteNG\extApps.xml
+Variables and arguments can be used to tell the external tool what to do.
+This is the list of variables supported by mRemoteNG:
+Variables always refer to the currently selected connection. Variable names are case-insensitive. Variables can be used in both the Filename and Arguments fields.
+mRemoteNG will also expand environment variables such as %PATH% and %USERPROFILE%. If you need to use an environment variable with the same name as an mRemoteNG variable, use \% instead of %. The most common use of this is for the USERNAME environment variable. %USERNAME% will be expanded to the username set in the currently selected connection. \%USERNAME\% will be expanded to the value set in the USERNAME environment variable.
+If you need to send a variable name to a program without mRemoteNG expanding it, use ^% instead of %. mRemoteNG will remove the caret (^) and leave the rest unchanged. For example, ^%USERNAME^% will be sent to the program as %USERNAME% and will not be expanded.
+Expanded variables will be escaped using the rules below. There are two levels of escaping that are done. The first is escaping for standard argument splitting (C/C++ argv, CommandLineToArgvW, etc). The second is escaping shell metacharacters for ShellExecute.
+To disable argument splitting escaping for a variable, precede its name with a minus (-) sign. For example, %-USERFIELD%.
+To disable both argument splitting and shell metacharacter escaping for a variable, precede its name with an exclamation point (!). For example, %!USERFIELD%. This is not recommended and may cause unexpected results.
+Only variables that have been expanded will be escaped. It is up to you to escape the rest of the arguments.
+| Arguments | +User Field | +Result | +
|---|---|---|
| %USERFIELD% | +"Example" Text | +\^"Example\^" Text | +
| %-USERFIELD% | +"Example" Text | +^"Example^" Text | +
| %!USERFIELD% | +"Example" Text | +"Example" Text | +
| ^%USERFIELD^% | +"Example" Text | +%USERFIELD% | +
| ^^%USERFIELD^^% | +"Example" Text | +^%USERFIELD^% | +
| -d "%USERFIELD%" | +c:\Example\ | +-d "c:\Example\\" | +
| -d "%-USERFIELD%" | +c:\Example\ | +-d "c:\Example\" | +
| -d "%USERFIELD%" | +Left & Right | +-d "Left ^& Right" | +
| -d "%!USERFIELD%" | +Left & Right | +-d "Left & Right" | +
| %WINDIR% | +N/A | +c:\Windows\ | +
| \%WINDIR\% | +N/A | +c:\Windows\ | +
| \^%WINDIR\^% | +N/A | +\%WINDIR\% | +
| \\%WINDIR\\% | +N/A | +\\%WINDIR\\% | +
First of all, start the external tools editor. To do this, click Tools in the main menu and select External Tools.
You will see a screen like on the following screenshot.
+
+
The fields below the list are greyed out because you haven't created an external tool entry yet.
To create one, right click the blank area in the list and select Add, as in the screenshot below.
+
+
This is what you'll get:
+
+
+
So the three fields are now available and need to be filled.
The Display Name is simply the name you will see when you want to launch that tool, so give it a descriptive name.
I named mine Traceroute as I will create a external tool that will start the tracert command in the console.
+
+
Ok, the next thing we'll need is a filename. This is the program that we want to be executed.
I simply type in cmd for a Windows cmd console.
+
+
Now the fun part comes in—the arguments.
The Windows cmd has a command line argument that tells the console to launch the command followed by that argument and stay open.
It's /K. (There's also /C, this is useful when you want the console to close after the command was executed)
In this case, I'll use /K as I want to look through the result when the command completes.
After that, I just type tracert %HostName%. This tells the console to do a traceroute on the hostname of the currently selected Connection.
+
+
Alright! That's all we'll need.
Now right click one of you connections, click Tools, External Tools and select Traceroute.
+
+
Voilà ! A console window will popup and execute your tracert command.
+
+
+
- SSH File Transfer functionality allows you to securely transfer files to a remote host over an encrypted tunnel using either SFTP or SCP. -
- - - -The primary use case is to upload individual files, such as configuration files, to a remote host.
- - - -- To begin, select Tools and then SSH File Transfer. - The tool will fill the window and allow you to input the configuration options. - Each piece of information is needed for a successful transfer. -
- -- To populate the Local File option, select the Browse button and navigate to - the desired file on the local filesystem. To populate the Remote File option, - manually type desired filesystem path, including the desired file name. -
- -- Once all options are populated, select Transfer and the progress bar at the bottom - of the window will show the progress. -
- -
- To troubleshoot issues with SSH File Transfer, consult the log under %AppData%\mRemoteNG\mRemoteNG.log. This log provides verbose information about successful and failed connections.
-
-
SSH File Transfer functionality allows you to securely transfer files to a remote host over an encrypted tunnel using either SFTP or SCP.
+ + +The primary use case is to upload individual files, such as configuration files, to a remote host.
+ + +To begin, select Tools and then SSH File Transfer. The tool will fill the window and allow you to input the configuration options. Each piece of information is needed for a successful transfer.
+To populate the Local File option, select the Browse button and navigate to the desired file on the local filesystem. To populate the Remote File option, manually type desired filesystem path, including the desired file name.
+Once all options are populated, select Transfer and the progress bar at the bottom of the window will show the progress.
+To troubleshoot issues with SSH File Transfer, consult the log under %AppData%\mRemoteNG\mRemoteNG.log. This log provides verbose information about successful and failed connections.
+
+
- Import/Export is for importing or exporting your configuration of connections. -
- - - -- Opens a normal file load dialog to open a exported xml or csv file for mRemoteNG. - See Export to file... further down this page for information on - exporting your connections. -
-- If you have servers that is located in a domain. Then this option can be used to fetch - those servers to easily import them to mRemoteNG. -
-- Here you can export your settings to a file to share or backup. The dialog shown below - is the dialog of which you chose the options to export. -
-
-
-
+
+
+ Import/Export is for importing or exporting your configuration of connections.
+ + +Opens a normal file load dialog to open a exported xml or csv file for mRemoteNG. See Export to file... further down this page for information on exporting your connections.
+If you have servers that is located in a domain. Then this option can be used to fetch those servers to easily import them to mRemoteNG.
+Here you can export your settings to a file to share or backup. The dialog shown below is the dialog of which you chose the options to export.
+
+
+
\ No newline at end of file
diff --git a/mRemoteV1/Resources/Help/ui_keyboardshortcuts.htm b/mRemoteV1/Resources/Help/ui_keyboardshortcuts.htm
index 31db9bbd..df04377b 100644
--- a/mRemoteV1/Resources/Help/ui_keyboardshortcuts.htm
+++ b/mRemoteV1/Resources/Help/ui_keyboardshortcuts.htm
@@ -1,132 +1,129 @@
-
+
-
-
- | Keybinding | -Action | -
|---|---|
| - Ctrl+N - | -New Connection | -
| - Ctrl+Shift+N - | -New Folder | -
| - Ctrl+O - | -Open Connection File... | -
| - Ctrl+S - | -Save Connection File | -
| - Ctrl+Shift+S - | -Save Connection File As... | -
| Keybinding | -Action | -
|---|---|
| - Ctrl+Alt+C - | -Jump to (Connections and Config) | -
| - Ctrl+Alt+E - | -Jump to (Notifications) | -
| - F11 - | -Fullscreen | -
| Keybinding | -Action | -
|---|---|
| - Ctrl+Shift+C - | -Connect | -
| - Ctrl+D - | -Duplicate | -
| - F2 - | -Rename | -
| - Del - | -Delete... | -
| - Ctrl+Up - | -Move Up | -
| - Ctrl+Down - | -Move Down | -
| Keybinding | -Action | -
|---|---|
| - F1 - | -mRemoteNG Help | -
| Keybinding | +Action | +
|---|---|
| + Ctrl+N + | +New Connection | +
| + Ctrl+Shift+N + | +New Folder | +
| + Ctrl+O + | +Open Connection File... | +
| + Ctrl+S + | +Save Connection File | +
| + Ctrl+Shift+S + | +Save Connection File As... | +
| Keybinding | +Action | +
|---|---|
| + Ctrl+Alt+C + | +Jump to (Connections and Config) | +
| + Ctrl+Alt+E + | +Jump to (Notifications) | +
| + F11 + | +Fullscreen | +
| Keybinding | +Action | +
|---|---|
| + Ctrl+Shift+C + | +Connect | +
| + Ctrl+D + | +Duplicate | +
| + F2 + | +Rename | +
| + Del + | +Delete... | +
| + Ctrl+Up + | +Move Up | +
| + Ctrl+Down + | +Move Down | +
| Keybinding | +Action | +
|---|---|
| + F1 + | +mRemoteNG Help | +
-- In this section we are going to explain the menus located in mRemoteNG. The above screenshot shows the main menu with colors. Short color explanation: -
- Red - Anchor to move menu around the interface
- Green - The menu items
-
| Item | -Description | -
|---|---|
| New Connection | -Will add a new connection to the Connections dialog after where the cursor is positioned. | -
| New Folder | -Add a new folder in the Connections dialog tree where the cursor is positioned. | -
| New Connection File | -Create a new connection file. Dialog will come up asking about: filename and where to place the new connection file. | -
| Open Connection File | -- Open a connection file. Dialog comes up asking about which file to open. For security reasons, this also shows a dialog - to ask if you want to save the current file before continuing. - | -
| Save Connection File | -Saves the currently opened connection file. If you are using a SQL server connection instead it will send a save to the SQL server. | -
| Save Connection File As... | -Saves the current connection file to a specific location on disk. | -
| Delete... | -Delete currently selected item in connections dialog. | -
| Rename | -Rename current selected item in connections dialog. | -
| Duplicate | -Duplicate current selected item in connections dialog. | -
| Reconnect All Open Connections | -Sends a reconnect to all the open connections in mRemoteNG. | -
| Exit | -Exit mRemoteNG application | -
| Item | -Description | -
|---|---|
| Add Connection Panel | -Create a new and empty panel. | -
| Connection Panels | -Jump to panel. | -
| Connections | -Show connections dialog | -
| Config | -Show config dialog | -
| Notifications | -Show notifications dialog | -
| Screenshots | -Open Screenshots panel (See: ScreenshotManager for more information) | -
| Jump To | -Place focus on "Connections and Config" or "Notifications" panel based on selection. | -
| Reset layout | -Resets the layout of panels and dialogs. Warning will come up about the action before continuing. | -
| Lock toolbar positions | -Locks the toolbars at the top of the application so you do not move around items by mistake. | -
| Quick Connect Toolbar | -Show quick connect toolbar | -
| External Tools Toolbar | -Show external tools toolbar | -
| Multi SSH Toolbar | -Show multi ssh toolbar | -
| Fullscreen | -Fullscreen mRemoteNG (will not fullscreen connection window but only the mRemoteNG application) | -
| Item | -Description | -
|---|---|
| SSH File Transfer | -Show SSH file transer panel (See: SSH File Transfer for more details) | -
| External Tools | -Show external tools dialog (See: External Tools for more details) | -
| Port Scan | -Show port scan dialog (See: Port Scan for more details) | -
| Components Check | -Show installed components requirements test | -
| Options | -Opens mRemoteNG global settings and options dialog | -
| Item | -Description | -
|---|---|
| mRemoteNG Help | -Show help panel (this panel) | -
| Website | -Go to mRemoteNG website | -
| Donate | -Go to mRemoteNG donation page. (Please help keep mRemoteNG awesome!) | -
| Support Forum | -Go to mRemoteNG suport forum (Best place is still chat for fast answers) | -
| Report a Bug | -Go to github page to report a bug found | -
| Check for Updates | -Opens dialog to check for any updates of mRemoteNG | -
| About | -Open about dialog for mRemoteNG (Shows contributors, changelog and more) | -
+ In this section we are going to explain the menus located in mRemoteNG. The above screenshot shows the main menu with colors. Short color explanation:
+ Red - Anchor to move menu around the interface
+ Green - The menu items
| Item | +Description | +
|---|---|
| New Connection | +Will add a new connection to the Connections dialog after where the cursor is positioned. | +
| New Folder | +Add a new folder in the Connections dialog tree where the cursor is positioned. | +
| New Connection File | +Create a new connection file. Dialog will come up asking about: filename and where to place the new connection file. | +
| Open Connection File | +Open a connection file. Dialog comes up asking about which file to open. For security reasons, this also shows a dialog to ask if you want to save the current file before continuing. | +
| Save Connection File | +Saves the currently opened connection file. If you are using a SQL server connection instead it will send a save to the SQL server. | +
| Save Connection File As... | +Saves the current connection file to a specific location on disk. | +
| Delete... | +Delete currently selected item in connections dialog. | +
| Rename | +Rename current selected item in connections dialog. | +
| Duplicate | +Duplicate current selected item in connections dialog. | +
| Reconnect All Open Connections | +Sends a reconnect to all the open connections in mRemoteNG. | +
| Exit | +Exit mRemoteNG application | +
| Item | +Description | +
|---|---|
| Add Connection Panel | +Create a new and empty panel. | +
| Connection Panels | +Jump to panel. | +
| Connections | +Show connections dialog | +
| Config | +Show config dialog | +
| Notifications | +Show notifications dialog | +
| Screenshots | +Open Screenshots panel (See: ScreenshotManager for more information) | +
| Jump To | +Place focus on "Connections and Config" or "Notifications" panel based on selection. | +
| Reset layout | +Resets the layout of panels and dialogs. Warning will come up about the action before continuing. | +
| Lock toolbar positions | +Locks the toolbars at the top of the application so you do not move around items by mistake. | +
| Quick Connect Toolbar | +Show quick connect toolbar | +
| External Tools Toolbar | +Show external tools toolbar | +
| Multi SSH Toolbar | +Show multi ssh toolbar | +
| Fullscreen | +Fullscreen mRemoteNG (will not fullscreen connection window but only the mRemoteNG application) | +
| Item | +Description | +
|---|---|
| SSH File Transfer | +Show SSH file transer panel (See: SSH File Transfer for more details) | +
| External Tools | +Show external tools dialog (See: External Tools for more details) | +
| Port Scan | +Show port scan dialog (See: Port Scan for more details) | +
| Components Check | +Show installed components requirements test | +
| Options | +Opens mRemoteNG global settings and options dialog | +
| Item | +Description | +
|---|---|
| mRemoteNG Help | +Show help panel (this panel) | +
| Website | +Go to mRemoteNG website | +
| Donate | +Go to mRemoteNG donation page. (Please help keep mRemoteNG awesome!) | +
| Support Forum | +Go to mRemoteNG suport forum (Best place is still chat for fast answers) | +
| Report a Bug | +Go to github page to report a bug found | +
| Check for Updates | +Opens dialog to check for any updates of mRemoteNG | +
| About | +Open about dialog for mRemoteNG (Shows contributors, changelog and more) | +
-
-- mRemoteNG is using panels and tabs to stay organized but also to create a better - view of all multitasking that is being done inside the application. Because - of that it can be good to know some more information on how to work with panels - and tabs to get the most out of those features. -
-- Panels are used to organize tabbed connections. This might seem - a bit confusing but its a great way to stay organized. Below is a few examples - of how to use panels to give you a hands on better view of them. -
-- For this tutorial we will keep it simple with Domain A and Domain B. Where both - have their own panels. -
-
-- Usually panels are created using connections and folders to stay organized - automatic when making connections. However you can also create panels manually. - See below: -
-
-- Creating manual panels will make you able to organize tabs manually in mRemoteNG. - To then open a connection to the new panel then Right click on connection and use - "Connect (with options)" > Choose panel before connecting -
-- The other option in the menu named "Connection Panels" will list all panels - in open in the current running mRemoteNG window. -
-- Right click menu for panels will give you a few more options for the panels: -
-
-- Speaking plain the tabs are also the connections that is open in mRemoteNG. - There are few tips and tricks regarding tabs and we will try to list them here. - In the below examples we will give you examples of RDP and SSH connections. -
-- The right click context menu allows you to trigger som additional actions on - tabs for example: Rename Tab, Duplicate Tab, Reconnect, Disconnect etc. Below - are the two context menus from RDP and SSH. -
-
-
-- If you check the difference between the menus you can see that there are some - actions that differ depending on the connection. This is intentional since its - specific for the type of connection. -
-- The default and always available menu items are: -
mRemoteNG is using panels and tabs to stay organized but also to create a better view of all multitasking that is being done inside the application. Because of that it can be good to know some more information on how to work with panels and tabs to get the most out of those features.
+Panels are used to organize tabbed connections. This might seem a bit confusing but its a great way to stay organized. Below is a few examples of how to use panels to give you a hands on better view of them.
+For this tutorial we will keep it simple with Domain A and Domain B. Where both have their own panels.
+
+ Usually panels are created using connections and folders to stay organized automatic when making connections. However you can also create panels manually. See below:
+
+ Creating manual panels will make you able to organize tabs manually in mRemoteNG. To then open a connection to the new panel then Right click on connection and use "Connect (with options)", then "Choose panel before connecting"
+The other option in the menu named "Connection Panels" will list all panels in open in the current running mRemoteNG window.
+Right click menu for panels will give you a few more options for the panels:
+
+ Speaking plain the tabs are also the connections that is open in mRemoteNG. There are few tips and tricks regarding tabs and we will try to list them here. In the below examples we will give you examples of RDP and SSH connections.
+The right click context menu allows you to trigger som additional actions on tabs for example: Rename Tab, Duplicate Tab, Reconnect, Disconnect etc. Below are the two context menus from RDP and SSH.
+
+
+ If you check the difference between the menus you can see that there are some actions that differ depending on the connection. This is intentional since its specific for the type of connection.
+The default and always available menu items are: +
- Notifications panel contains information for any errors or informational messages that - mRemoteNG triggers. Some example errors can be if there is a problem to connect, information - on lost connection and so much more. -
-- Notification settings can be found in (Tools > Options > Notifications) below we will explain what - can be set and how they do affect for various troubleshooting. -
- - - -
-- This will tell mRemoteNG what type of messages and the level of messages to send to the panel. - It does not the level for the log that mRemoteNG has but only for panel output. -
-There is also 2 different options mentioned below:
-- Here you define the logging of messages. That is a continues log which can be used to backtrack - any error that has occurred. Good when for example reporting issues about mRemoteNG or to check - more details about problems. -
-
-- When items are selected here you will recieve a popup on the error that occurrs based on level - chosen in settings here. This can be useful if you do not want to use the notification area and only - get a popup if error occurs. (default: all off) -
- - + + +Notifications panel contains information for any errors or informational messages that mRemoteNG triggers. Some example errors can be if there is a problem to connect, information on lost connection and so much more.
+Notification settings can be found in (Tools > Options > Notifications) below we will explain what can be set and how they do affect for various troubleshooting.
+ + +
+ This will tell mRemoteNG what type of messages and the level of messages to send to the panel. It does not the level for the log that mRemoteNG has but only for panel output.
+There is also 2 different options mentioned below:
+Here you define the logging of messages. That is a continues log which can be used to backtrack any error that has occurred. Good when for example reporting issues about mRemoteNG or to check more details about problems.
+
+ When items are selected here you will recieve a popup on the error that occurrs based on level chosen in settings here. This can be useful if you do not want to use the notification area and only get a popup if error occurs. (default: all off)
+ + \ No newline at end of file diff --git a/mRemoteV1/Resources/Help/ui_options.htm b/mRemoteV1/Resources/Help/ui_options.htm index 6db408cf..bc7e3a65 100644 --- a/mRemoteV1/Resources/Help/ui_options.htm +++ b/mRemoteV1/Resources/Help/ui_options.htm @@ -1,508 +1,404 @@ - + - - -- Options window which can also be named settings is the window where you can personalize - your options for all of mRemoteNG. This includes how to set logging, credentials and so on. - Continue reading for the details of the different options here. -
-- Options below are for the various settings for Startup/Exit of mRemoteNG. -
-| - Option - | -- Default - | -- Description - | -
| Save connection on exit | -On | -Save to connection file/database on exit of mRemoteNG. | -
| Reconnect to previously opened sessions on startup | -Off | -- This option will allow you to open the connection from which - you where connected to after last exit of application. - | -
| Allow only a single instance of the application (mRemoteNG restart required) | -Off | -- Enforces and makes sure only a single instance of mRemoteNG is running on the - computer. - | -
| Check proper installation of components at startup | -Off | -Opens the panel for Components Check on every startup. | -
- Various options for mRemoteNG appearance. -
-| - Option - | -- Default - | -- Description - | -
| Language | -(Automatically Detect) | -Which language to use for the interface of mRemoteNG. | -
| Show description tooltips in connection tree | -Off | -- Holding mouse over a item in connection tree will show a popout from mouse - with information. - | -
| Show full connections file path in window title | -Off | -- Adds the complete path to the title of mRemoteNG to where the connection file is - located. - | -
| Always show notification area icon | -Off | -- Adds mRemoteNG to the taskbar in the OS. - | -
| Minimize to notification area | -Off | -- Will place mRemoteNG in taskbar on minimize. - | -
- Various settings for how tabs & panels should work in mRemoteNG. -
-| - Option - | -- Default - | -- Description - | -
| Always show panel tabs | -Off | -Will always show the tabs & panels in mRemoteNG | -
| Open new tab to the right of the currently selected tab | -On | -- When active then open next tab on the right of the active selection in mRemoteNG. Turn - this off and next tab will open the next connection at the end of all tabs. - | -
| Show logon information on tab names | -Off | -Show your login in the connection tab. | -
| Show protocols on tab names | -Off | -When active then in the tab show what protocol is used for the connection. | -
| Identify quick connect tabs by adding the prefix "Quick:" | -Off | -- When active shows Quick: before the connection name in the tab connection to easier - identify what is a quick connection and what is a non quick connection. - | -
| Double click on tab closes it | -On | -- When double clicking a tab it will close the connection but does not log you - out from the server. The connection in this case is active on the destination - server. - | -
| Always show panel selection dialog when opening connections | -Off | -- Option to allow you to always select what panel to place the connection on. - If this is off it will create a General panel where the connection is placed - or use the connections set panel from the connection options. - | -
| Create a empty panel when mRemoteNG starts | -Off | -- On startup if this is active mRemoteNG will create a panel mentioned under - Panel Name: - | -
-
-| - Option - | -- Default - | -- Description - | -
| Single click on connections opens it | -Off | -- In connection tree when this is active will try to connect on single click. By default - this is turned off to use double click to open connection. - | -
| Single click on opened connection in Connection Tree switches to the opened Connection Tab | -Off | -- Allows you to single click on a active connection in the connection tree to go to that - open connection in the tabs faster. - | -
| Set hostname like display name when creating or renaming connections | -Off | -- Will make mRemoteNG try to use the remote host hostname to set the title of the tab - in mRemoteNG. - | -
| Save connections after every exit | -On | -- When active mRemoteNG will save the connection tree to the active config - after every exit. If inactive then you have to save using - File > Save Connection File or keyboard shortcut - Ctrl+S - | -
| Filter search matches in connection tree | -Off | -- Allows you to filter out the connections to which does not match - your filter search in the connection tree. If not active the search - will only select the filter to which you do search. - | -
| RDP Reconnect count | -5 | -
- Value in seconds - |
-
| RDP Connection Timeout | -20 | -
- Value in seconds - |
-
| Auto save time in minutes (0 means disabled) | -0 | -
- Value in minutes - |
-
| When closing connections | -Warn me when closing connections | -
- Various options of how mRemoteNG should act when you close connections.
- The different options are listed below:
-
|
-
- Options for credentials in mRemoteNG. The main purpose here - is that when you have empty username, password or domain field - then use below information. -
-| - Option - | -- Default - | -- Description - | -
| None | -On | -Use no specific settings on login | -
| My Current credentials (Windows logon information) | -Off | -- This option will use the logon information for the OS. This is useful if you - are in a domain that uses specific credentials and want to login to servers - with those credentials. - | -
| The following: | -Off | -- Use one or two of the options below for the empty login or all of them. - For example if you have a different domain that you login to the servers with. - | -
| - Option - | -- Default - | -- Description - | -
| Use SQL Server to load & save connections | -Off | -Enable to fetch connections from a database. | -
- Options for how mRemoteNG should check for updates from the website. -
-| - Option - | -- Default - | -- Description - | -
| Check for updates at startup | -On (Every 14 days) | -- Here you can choose how often mRemoteNG checks for updates. - Standard is every 14 days - | -
| Release Channel: | -Stable | -- The main channel to use for mRemoteNG. Note that the channels are described under - the selection. Stable is suggested for normal usage but its always good to get - feedback on upcoming releases. - | -
| Use a proxy server to connect | -Off | -- Proxy to connect through to check for updates. This is not a proxy connection - for when you connect to a server but more to check for updates. - | -
- UI themes. This is not enabled by default but can be used - inside mRemoteNG. To enable themes you have to first - enable it in the checkbox at the bottom of the options. - Then restart mRemoteNG in order for it to work. -
-- Default theme is: vs2015light -
-| - Option - | -- Default - | -- Description - | -
| Automatically get session information | -Off | -- |
| Automatically try to reconnect when disconnected from server (RDP & ICA only) | -Off | -- | -
| Use UTF8 encoding for RDP "Load Balance info" property | -Off | -- |
| Use custom PuTTY path: | -Off | -- |
| To configure PuTTY sessions click this button: | -Launch PuTTY | -Will launch the putty agent so you can edit the sessions. | -
| Maximum PuTTY and integrated external tools wait time: | -2 seconds | -- |
Options window which can also be named settings is the window where you can personalize your options for all of mRemoteNG. This includes how to set logging, credentials and so on. Continue reading for the details of the different options here.
+Options below are for the various settings for Startup/Exit of mRemoteNG.
+| + Option + | ++ Default + | ++ Description + | +
| Save connection on exit | +On | +Save to connection file/database on exit of mRemoteNG. | +
| Reconnect to previously opened sessions on startup | +Off | +This option will allow you to open the connection from which you where connected to after last exit of application. | +
| Allow only a single instance of the application (mRemoteNG restart required) | +Off | +Enforces and makes sure only a single instance of mRemoteNG is running on the computer. | +
| Check proper installation of components at startup | +Off | +Opens the panel for Components Check on every startup. | +
Various options for mRemoteNG appearance.
+| + Option + | ++ Default + | ++ Description + | +
| Language | +(Automatically Detect) | +Which language to use for the interface of mRemoteNG. | +
| Show description tooltips in connection tree | +Off | +Holding mouse over a item in connection tree will show a popout from mouse with information. | +
| Show full connections file path in window title | +Off | +Adds the complete path to the title of mRemoteNG to where the connection file is located. | +
| Always show notification area icon | +Off | +Adds mRemoteNG to the taskbar in the OS. | +
| Minimize to notification area | +Off | +Will place mRemoteNG in taskbar on minimize. | +
Various settings for how tabs & panels should work in mRemoteNG.
+| + Option + | ++ Default + | ++ Description + | +
| Always show panel tabs | +Off | +Will always show the tabs & panels in mRemoteNG | +
| Open new tab to the right of the currently selected tab | +On | +When active then open next tab on the right of the active selection in mRemoteNG. Turn this off and next tab will open the next connection at the end of all tabs. | +
| Show logon information on tab names | +Off | +Show your login in the connection tab. | +
| Show protocols on tab names | +Off | +When active then in the tab show what protocol is used for the connection. | +
| Identify quick connect tabs by adding the prefix "Quick:" | +Off | +When active shows Quick: before the connection name in the tab connection to easier identify what is a quick connection and what is a non quick connection. | +
| Double click on tab closes it | +On | +When double clicking a tab it will close the connection but does not log you out from the server. The connection in this case is active on the destination server. | +
| Always show panel selection dialog when opening connections | +Off | +Option to allow you to always select what panel to place the connection on. If this is off it will create a General panel where the connection is placed or use the connections set panel from the connection options. | +
| Create a empty panel when mRemoteNG starts | +Off | +On startup if this is active mRemoteNG will create a panel mentioned under Panel Name: | +
| + Option + | ++ Default + | ++ Description + | +
| Single click on connections opens it | +Off | +In connection tree when this is active will try to connect on single click. By default this is turned off to use double click to open connection. | +
| Single click on opened connection in Connection Tree switches to the opened Connection Tab | +Off | +Allows you to single click on a active connection in the connection tree to go to that open connection in the tabs faster. | +
| Set hostname like display name when creating or renaming connections | +Off | +Will make mRemoteNG try to use the remote host hostname to set the title of the tab in mRemoteNG. | +
| Save connections after every exit | +On | +When active mRemoteNG will save the connection tree to the active config after every exit. If inactive then you have to save usingFile > Save Connection File or keyboard shortcutCtrl+S + | +
| Filter search matches in connection tree | +Off | +Allows you to filter out the connections to which does not match your filter search in the connection tree. If not active the search will only select the filter to which you do search. | +
| RDP Reconnect count | +5 | +Value in seconds + |
+
| RDP Connection Timeout | +20 | +Value in seconds + |
+
| Auto save time in minutes (0 means disabled) | +0 | +Value in minutes + |
+
| When closing connections | +Warn me when closing connections | +Various options of how mRemoteNG should act when you close connections. The different options are listed below:
|
+
Options for credentials in mRemoteNG. The main purpose here is that when you have empty username, password or domain field then use below information.
+| + Option + | ++ Default + | ++ Description + | +
| None | +On | +Use no specific settings on login | +
| My Current credentials (Windows logon information) | +Off | +This option will use the logon information for the OS. This is useful if you are in a domain that uses specific credentials and want to login to servers with those credentials. | +
| The following: | +Off | +Use one or two of the options below for the empty login or all of them. For example if you have a different domain that you login to the servers with. | +
| + Option + | ++ Default + | ++ Description + | +
| Use SQL Server to load & save connections | +Off | +Enable to fetch connections from a database. | +
Options for how mRemoteNG should check for updates from the website.
+| + Option + | ++ Default + | ++ Description + | +
| Check for updates at startup | +On (Every 14 days) | +Here you can choose how often mRemoteNG checks for updates. Standard is every 14 days | +
| Release Channel: | +Stable | +The main channel to use for mRemoteNG. Note that the channels are described under the selection. Stable is suggested for normal usage but its always good to get feedback on upcoming releases. | +
| Use a proxy server to connect | +Off | +Proxy to connect through to check for updates. This is not a proxy connection for when you connect to a server but more to check for updates. | +
UI themes. This is not enabled by default but can be used inside mRemoteNG. To enable themes you have to first enable it in the checkbox at the bottom of the options. Then restart mRemoteNG in order for it to work.
+Default theme is: vs2015light
+| + Option + | ++ Default + | ++ Description + | +
| Automatically get session information | +Off | ++ |
| Automatically try to reconnect when disconnected from server (RDP & ICA only) | +Off | ++ |
| Use UTF8 encoding for RDP "Load Balance info" property | +Off | ++ |
| Use custom PuTTY path: | +Off | ++ |
| To configure PuTTY sessions click this button: | +Launch PuTTY | +Will launch the putty agent so you can edit the sessions. | +
| Maximum PuTTY and integrated external tools wait time: | +2 seconds | ++ |
- The Port Scan feature (under Tools > Port Scan) is similar to a nmap port scan. - It will scan a range of IP addresses and to determine if specific mRemoteNG supported - protocols are active. Hosts can then be bulk imported into mRemoteNG. -
- - - -- You've just inherited a new network with little to no documentation. - Inputting a range of IP addresses and scanning your entire network - should give you a good idea of what is currently online. - Importing those devices will then give you a quick - (relatively, scanning a large subnet will take a while) way to get into those devices. -
- - - -The Port Scan feature (under Tools > Port Scan) is similar to a nmap port scan. It will scan a range of IP addresses and to determine if specific mRemoteNG supported protocols are active. Hosts can then be bulk imported into mRemoteNG.
+ + +You've just inherited a new network with little to no documentation. Inputting a range of IP addresses and scanning your entire network should give you a good idea of what is currently online. Importing those devices will then give you a quick (relatively, scanning a large subnet will take a while) way to get into those devices.
+ + +- The Quick Connect functionality of mRemoteNG allows you to quickly connect to a remote host using a variety of network protocols. -
-
- The primary use case for Quick Connect is to connect to remote hosts when you already remember the DNS hostname/IP address and the appropriate protocol for the connection.
-
- An additional use case is to connect to remote hosts saved as a connection quickly.
-
OR
-
- To use Quick Connect, ensure the Quick Connect toolbar is enabled by selecting View and then Quick Connect Toolbar.
-
- Next, input a DNS host name or IP address into the box labeled "Connect". This box will also save previous entries during your session.
-
-
-
-
-
-
-
- Select the appropriate network protocol by clicking the arrow next to the Connect box.
-
-
-
-
- If you wish to use an existing connection, select the globe icon next to the protocol button and select the appropriate connection.
-
The Quick Connect functionality of mRemoteNG allows you to quickly connect to a remote host using a variety of network protocols.
+The primary use case for Quick Connect is to connect to remote hosts when you already remember the DNS hostname/IP address and the appropriate protocol for the connection.
+
An additional use case is to connect to remote hosts saved as a connection quickly.
OR
+To use Quick Connect, ensure the Quick Connect toolbar is enabled by selecting View and then Quick Connect Toolbar.
Next, input a DNS host name or IP address into the box labeled "Connect". This box will also save previous entries during your session.
+
+
+
+
+
+
Select the appropriate network protocol by clicking the arrow next to the Connect box.
+
+
+
If you wish to use an existing connection, select the globe icon next to the protocol button and select the appropriate connection.
- The screenshot manager is a panel and tool that can be used to organize - and take screenshots inside mRemoteNG. -
- - -- To take a screenshot of a instance its as easy as to right click on the - connection tab and press Screenshot and it will open the screenshot - manager. -
-
-
-- On the left image you will see the right click menu for the connection tab. Clicking the - screenshot there will allow mRemoteNG to create a screenshot. -
-- The right image is where the screenshots are stored in mRemoteNG. Here you can store - and then decide what to do with the images after you are done taking screenshots. -
- - - -- The manager is a simple tool for saving and deleting screenshots. If you need to do - more with the screenshots then the suggestion is to open them in a third party app. - Here is what the manager allows you to do: -
- Once you press save, a window to save the files will come up where you want to save - the screenshots. -
-- Short summary of screenshot manager is that you can sit and create screenshots without - having to open a different manager all the time and instead let mRemoteNG create the - main screenshot which can be edited later on. -
- - + + +The screenshot manager is a panel and tool that can be used to organize and take screenshots inside mRemoteNG.
+ +To take a screenshot of a instance its as easy as to right click on the connection tab and press Screenshot and it will open the screenshot manager.
+
+
+ On the left image you will see the right click menu for the connection tab. Clicking the screenshot there will allow mRemoteNG to create a screenshot.
+The right image is where the screenshots are stored in mRemoteNG. Here you can store and then decide what to do with the images after you are done taking screenshots.
+ + +The manager is a simple tool for saving and deleting screenshots. If you need to do more with the screenshots then the suggestion is to open them in a third party app. Here is what the manager allows you to do:
Once you press save, a window to save the files will come up where you want to save the screenshots.
+Short summary of screenshot manager is that you can sit and create screenshots without having to open a different manager all the time and instead let mRemoteNG create the main screenshot which can be edited later on.
+ + \ No newline at end of file diff --git a/mRemoteV1/Resources/Help/ui_sql_configuration.htm b/mRemoteV1/Resources/Help/ui_sql_configuration.htm index c6374d31..28331637 100644 --- a/mRemoteV1/Resources/Help/ui_sql_configuration.htm +++ b/mRemoteV1/Resources/Help/ui_sql_configuration.htm @@ -1,63 +1,56 @@ - + - - -- The list below are databases which have been tested on for support. Note that other databases may be supported in the future. -
-| Script (click on script below for your db type) | -Description | -
|---|---|
| - Microsoft™ SQL script - | -Microsoft™ SQL Server | -
The list below are databases which have been tested on for support. Note that other databases may be supported in the future.
+| Script (click on script below for your db type) | +Description | +
|---|---|
| + Microsoft™ SQL script + | +Microsoft™ SQL Server | +