created user documentation for default connection properties

This commit is contained in:
David Sparer
2019-10-16 11:46:33 -05:00
parent b2c5298400
commit 00a5fc0142
4 changed files with 46 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

View File

@@ -11,6 +11,7 @@ User Interface
user_interface/panels.rst
user_interface/menus.rst
user_interface/connections.rst
user_interface/default_connection_properties.rst
user_interface/quick_connect.rst
user_interface/port_scan.rst
user_interface/screenshot_manager.rst

View File

@@ -0,0 +1,34 @@
*****************************
Default Connection Properties
*****************************
Default connection properties are a template that is applied when creating new connections. You can set both property values and inheritance settings that will be set in new connections.
.. note::
Currently, default connection properties are saved within the user settings of mRemoteNG and not with the connection file. Sharing a connection file between multiple machines will not share default connection properties.
How it is used
==============
New Folders/Connections
-----------------------
When a new folder or connection is created, all default properties and default inheritance are applied to it.
.. note::
Changing default properties does not affect existing connections. The default values are only applied when the connection is first created.
Quick Connections
-----------------
Default connection properties are also used when establishing quick connections. See :doc:`quick_connect` for more details.
How to set them
===============
You can set default properties and inheritance by going to the Connection Tree and clicking the appropriate button for the default settings you would like to change.
.. figure:: /images/default_properties.png
- **Red** - Default connection properties
- **Green** - Default connection inheritance

View File

@@ -23,4 +23,14 @@ Select the appropriate network protocol by clicking the arrow next to the Connec
.. figure:: /images/quick_connect_03.png
If you wish to use an existing connection, select the globe icon next to the protocol button and select the appropriate connection.
If you wish to use an existing connection, select the globe icon next to the protocol button and select the appropriate connection.
Configuration
=============
Quick connections take most of their configuration from the :doc:`default_connection_properties`.
All default properties are used `except` for:
- Hostname
- Protocol
- Port (the default port for the selected protocol is used)