From 00a5fc014236095a9b35858ca28142793defc3cf Mon Sep 17 00:00:00 2001 From: David Sparer Date: Wed, 16 Oct 2019 11:46:33 -0500 Subject: [PATCH] created user documentation for default connection properties --- .../images/default_properties.png | Bin 0 -> 2195 bytes mRemoteV1/Documentation/user_interface.rst | 1 + .../default_connection_properties.rst | 34 ++++++++++++++++++ .../user_interface/quick_connect.rst | 12 ++++++- 4 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 mRemoteV1/Documentation/images/default_properties.png create mode 100644 mRemoteV1/Documentation/user_interface/default_connection_properties.rst diff --git a/mRemoteV1/Documentation/images/default_properties.png b/mRemoteV1/Documentation/images/default_properties.png new file mode 100644 index 0000000000000000000000000000000000000000..3889c2b88617653b4746639477eb6c0a25a5745f GIT binary patch literal 2195 zcmV;E2yFL>P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D2q;NJK~!i%?V0^= zR8<ljl6=%%akY7MY%&USPfuUY0XL)45|or1^$H09%*@u!T#c*L$z!4A;y0nK1o7 zY+?F5D;NZ@g-HNgq=77HTHf(4OM$tY4J z8cV_XJSdr7d|o7G?AM$>e_j?XTBKUjb0-TTWyU0cEz*iaX%dM<3bT4>KPv00{wsz1M&#u^ z|B+2Kqplbvs7SrNy%NKB>+I~5j*brFm=p{G^nv%lTVN;H0k(rOuoaYm4PYH81TTZv zfH#gw03&Un3DkkT$vz(fiNuNYid0ZgAdyH!^7Hd$>C&Y$|IS3Z7tdG`h?EzJ8lMxJ zBE56$l1xthkQD`Q54mEHpdwMCvuDrB@bIv-wze9_q+k%>-(WIJUI5-WCIO5b0;j=8 z;EiOT556LC5;gI7+*(E&85x;b)+iERx_1n*DbkxqzEX1R8GJ)_4V25yzHL(8vsKEv zH%V#Ndf9klt*q-q+k%>O+Y#J zfL(xDsT?pPm4b~xXQP(@$36qRaZCajsR7-f18h$A`H)d0P99$bCz35ETZ>dzSErVy z%F5m7i>f~Fy~gz7bvC-byhZW1IV;%|sp9a2k|XHFu}{6;?}|Z!ip1rNnTQfKG&C5; zq+k%B0#FVK2**AJym3qd7}*V?%jEu&WwLaQ=UEyuiqzfREp2UWidc+U0~3yZ=SvNO z>BT#XYzmr}7d6UaQ>1d#LzLs)j`2Wn?257;R}2zVq*-AQfZ2y~yc-aXT>-ptOaj;< ztw=;=4G;R+Trv{lFbh#o-t%vYWXei5McRg)xEwe+F4bM*QUfRw+nUY`(h$2KpMH5o9xm>5#USav4{M?R{(gnt zv2}HI$?@aI<>=9)u4S&izTOzaJNaY_xB~VAN<$8SYEYBBXG)zMMCn6PPk%_bRtn8Q@@GY+FE13ck&6h_X$98m~kkKGXr@u(m9Y1ym3qd zC_XgwrQ=aUADH#hmJLRc9LpFbist3Hp7Ubs6-oD-@Dpi$_5bAZOC|9ip1U9vmgSNhyN<~q4mZw2@r@b zptIA)dnDAH?01l{*w$x9PP9yO%}5$%p$H_>^^%5HVPT>A9E!x}JiFrM9OuMOq_z7$ zldr$|PD#V7xo<+X`fBQpW9j>8S4WYSZ}wl>xO5Tj(wqm6?d|PqIcsTYkwb?L&Ghp- zRaaLls;a7H`V|HN)`G7ArD4WtPPUqVfmgsmz{5)}g?|s;p@$2su|)<$Q+C&0P9)!Zwg7}`#- z;VuacpgjWwu$BT#p1#Qy%U2}lMA|%%BvCAH6p2Eao>QE~ix;cUW;<7rR`32qE)hF?ec-AkIUd4;hS7>oD;8Lb{PgkfLSQn|F^w&OXvjtZbR%BZ@-?6D3Ru4#QtX% zB5~r<9Z1ggClXa)Ln3E^9W!Jmot4tb=EP5=RlA1d;+1bDetAm9E?$+<_#}2_-^jVo z6G|Erk8bj>k+>tHKwN$)i0)?=(mOO~aZP!g=zfJ`;x((lMGyyLU=(m?#-e%{{4x9+ z*@Tw06eVICC?hcoahuPb8h=+y_TRnhPPuc(5?NCAJNf;}Uy1tNjZh-)?6S>Bxjc}h zM68WsQ54$AV%xODQKX`xBHwI8{EO|+PIvU|oli zmF55c1IbsxbKptv1b7TQ0>a<{a2I$me2Z*G%S^{0IQ3 Vr+iy`bA8Fl~w literal 0 HcmV?d00001 diff --git a/mRemoteV1/Documentation/user_interface.rst b/mRemoteV1/Documentation/user_interface.rst index 3a4723509..61a85abeb 100644 --- a/mRemoteV1/Documentation/user_interface.rst +++ b/mRemoteV1/Documentation/user_interface.rst @@ -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 diff --git a/mRemoteV1/Documentation/user_interface/default_connection_properties.rst b/mRemoteV1/Documentation/user_interface/default_connection_properties.rst new file mode 100644 index 000000000..1dad4167e --- /dev/null +++ b/mRemoteV1/Documentation/user_interface/default_connection_properties.rst @@ -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 diff --git a/mRemoteV1/Documentation/user_interface/quick_connect.rst b/mRemoteV1/Documentation/user_interface/quick_connect.rst index fa8195970..6992084db 100644 --- a/mRemoteV1/Documentation/user_interface/quick_connect.rst +++ b/mRemoteV1/Documentation/user_interface/quick_connect.rst @@ -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. \ No newline at end of file +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)