gsadmin/ssh.net
1
0
Fork 0
mirror of https://github.com/sshnet/SSH.NET.git synced 2026-09-10 01:05:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation content file to start creation of CHM help file

Browse Source
This commit is contained in:
olegkap_cp
2010-12-23 21:06:07 +00:00
parent 2303affe79
commit 8bd42a06f1
18 changed files with 927 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Renci.SshClient/Renci.SshClient.sln
-18
View File
@@ -29,9 +29,6 @@ Global
Debug|Any CPU = Debug|Any CPU
Debug|Mixed Platforms = Debug|Mixed Platforms
Debug|x86 = Debug|x86
DebugNoTimeout|Any CPU = DebugNoTimeout|Any CPU
DebugNoTimeout|Mixed Platforms = DebugNoTimeout|Mixed Platforms
DebugNoTimeout|x86 = DebugNoTimeout|x86
Release|Any CPU = Release|Any CPU
Release|Mixed Platforms = Release|Mixed Platforms
Release|x86 = Release|x86
@@ -42,11 +39,6 @@ Global
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Debug|x86.ActiveCfg = Debug|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.DebugNoTimeout|Any CPU.ActiveCfg = DebugNoTimeout|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.DebugNoTimeout|Any CPU.Build.0 = DebugNoTimeout|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.DebugNoTimeout|Mixed Platforms.ActiveCfg = DebugNoTimeout|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.DebugNoTimeout|Mixed Platforms.Build.0 = DebugNoTimeout|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.DebugNoTimeout|x86.ActiveCfg = DebugNoTimeout|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Release|Any CPU.Build.0 = Release|Any CPU
{2F5F8C90-0BD1-424F-997C-7BC6280919D1}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
@@ -57,11 +49,6 @@ Global
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Debug|Mixed Platforms.ActiveCfg = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Debug|Mixed Platforms.Build.0 = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Debug|x86.ActiveCfg = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.DebugNoTimeout|Any CPU.ActiveCfg = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.DebugNoTimeout|Any CPU.Build.0 = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.DebugNoTimeout|Mixed Platforms.ActiveCfg = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.DebugNoTimeout|Mixed Platforms.Build.0 = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.DebugNoTimeout|x86.ActiveCfg = Debug|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Release|Any CPU.Build.0 = Release|Any CPU
{C45379B9-17B1-4E89-BC2E-6D41726413E8}.Release|Mixed Platforms.ActiveCfg = Release|Any CPU
@@ -72,11 +59,6 @@ Global
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Debug|Mixed Platforms.Build.0 = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Debug|x86.ActiveCfg = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Debug|x86.Build.0 = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.DebugNoTimeout|Any CPU.ActiveCfg = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.DebugNoTimeout|Mixed Platforms.ActiveCfg = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.DebugNoTimeout|Mixed Platforms.Build.0 = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.DebugNoTimeout|x86.ActiveCfg = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.DebugNoTimeout|x86.Build.0 = Debug|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Release|Any CPU.ActiveCfg = Release|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Release|Mixed Platforms.ActiveCfg = Release|x86
{E53AE1B6-5EE8-4B56-B59F-0E7370C8B886}.Release|Mixed Platforms.Build.0 = Release|x86
Renci.SshClient/Renci.SshClient/SshBaseClient.cs → Renci.SshClient/Renci.SshClient/BaseClient.cs
+7 -4
View File
@@ -10,7 +10,10 @@ using System.Threading;
namespace Renci.SshClient
{
public abstract class SshBaseClient : IDisposable
/// <summary>
/// Serves as base class for client implementations, provides common client functionality.
/// </summary>
public abstract class BaseClient : IDisposable
{
private TimeSpan _keepAliveInterval;
@@ -74,10 +77,10 @@ namespace Renci.SshClient
public event EventHandler<AuthenticationEventArgs> Authenticating;
/// <summary>
/// Initializes a new instance of the <see cref="SshBaseClient"/> class.
/// Initializes a new instance of the <see cref="BaseClient"/> class.
/// </summary>
/// <param name="connectionInfo">The connection info.</param>
public SshBaseClient(ConnectionInfo connectionInfo)
public BaseClient(ConnectionInfo connectionInfo)
{
this.ConnectionInfo = connectionInfo;
this.Session = new Session(connectionInfo);
@@ -206,7 +209,7 @@ namespace Renci.SshClient
}
}
~SshBaseClient()
~BaseClient()
{
// Do not re-create Dispose clean-up code here.
// Calling Dispose(false) is optimal in terms of
Renci.SshClient/Renci.SshClient/Documentation/Content/Extensibility.AddAuthenticationMethod.aml
+96
View File
@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="ec6dd28e-c788-4812-89ae-53a26420e50b" revisionNumber="1">
<developerWalkthroughDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<!-- Uncomment this to generate an outline of the section and sub-section
titles. Specify a numeric value as the inner text to limit it to
a specific number of sub-topics when creating the outline. Specify
zero (0) to limit it to top-level sections only. -->
<!-- <autoOutline /> -->
<para>Required introduction</para>
</introduction>
<!-- <prerequisites><content>Optional prerequisites info</content></prerequisites> -->
<!-- One or more procedure or section with procedure -->
<procedure>
<title>Procedure title</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
<!-- Optional additional procedure or section with procedure -->
<section address="Section1">
<title>Optional section title</title>
<content>
<procedure>
<title>Procedure #2</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
</content>
</section>
<!-- Optional next steps info
<nextSteps>
<content><para>Next steps info goes here</para></content>
</nextSteps>
-->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerWalkthroughDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/Extensibility.AddEncryption.aml
+96
View File
@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="2c568137-b080-45b0-86d0-cd157e9d0604" revisionNumber="1">
<developerWalkthroughDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<!-- Uncomment this to generate an outline of the section and sub-section
titles. Specify a numeric value as the inner text to limit it to
a specific number of sub-topics when creating the outline. Specify
zero (0) to limit it to top-level sections only. -->
<!-- <autoOutline /> -->
<para>Required introduction</para>
</introduction>
<!-- <prerequisites><content>Optional prerequisites info</content></prerequisites> -->
<!-- One or more procedure or section with procedure -->
<procedure>
<title>Procedure title</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
<!-- Optional additional procedure or section with procedure -->
<section address="Section1">
<title>Optional section title</title>
<content>
<procedure>
<title>Procedure #2</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
</content>
</section>
<!-- Optional next steps info
<nextSteps>
<content><para>Next steps info goes here</para></content>
</nextSteps>
-->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerWalkthroughDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/Extensibility.AddHashAlgorithm.aml
+96
View File
@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="ea611b0c-8312-433b-88b1-d64a7222566b" revisionNumber="1">
<developerWalkthroughDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<!-- Uncomment this to generate an outline of the section and sub-section
titles. Specify a numeric value as the inner text to limit it to
a specific number of sub-topics when creating the outline. Specify
zero (0) to limit it to top-level sections only. -->
<!-- <autoOutline /> -->
<para>Required introduction</para>
</introduction>
<!-- <prerequisites><content>Optional prerequisites info</content></prerequisites> -->
<!-- One or more procedure or section with procedure -->
<procedure>
<title>Procedure title</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
<!-- Optional additional procedure or section with procedure -->
<section address="Section1">
<title>Optional section title</title>
<content>
<procedure>
<title>Procedure #2</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
</content>
</section>
<!-- Optional next steps info
<nextSteps>
<content><para>Next steps info goes here</para></content>
</nextSteps>
-->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerWalkthroughDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/Extensibility.aml
+21
View File
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="96a68c17-9f73-4c26-816e-bfce16366094" revisionNumber="1">
<developerSDKTechnologyOverviewOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<para>Required introduction</para>
</introduction>
<inThisSection>
<content>
<para>"In This Section" info</para>
</content>
</inThisSection>
<!-- <reference>Optional reference info</reference> -->
<!-- <relatedSections>Optional related sections info</relatedSections> -->
<!-- <externalResources>Optional external resources info</externalResources> -->
</developerSDKTechnologyOverviewOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/HowTo.Connect.aml
+157
View File
@@ -0,0 +1,157 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="fee6a616-6282-4419-a517-7c33c56158ee" revisionNumber="1">
<developerOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<introduction>
The library supports differnet method to connect to SSH server.
It also has support to add a custom authentication method if needed. Method supported out of the box are :<newTerm>publickey</newTerm>, <newTerm>password</newTerm> and <newTerm>keyboard-interactive</newTerm>. There is also support for different events that can occure during authentication. For example: server can send an information that need to be presented to the user upon login, user's password is expired and new password could be provided to change user's password and others scenrios.
By using <codeEntityReference>T:Renci.SshClient.ConnectionInfo</codeEntityReference> you can specify connection timeout, which in this case will wait 30 seconds while tying to connect to the server after which it will throw an exception if it did not connect.
</introduction>
<section>
<title>Connect using password.</title>
<content>
<para>Following examples show how to connect using username and password combination.</para>
<codeExample>
<list class="ordered">
<listItem>
<para>Connecting using username to server's default port</para>
<code language="cs">
using (var client = new SshClient("host", "username", "password"))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
<listItem>
<para>Connecting using username to server's port 1234</para>
<code language="cs">
using (var client = new SshClient("host", 1234, "username", "password"))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
<listItem>
<para>
This is similar to previouse example but it uses <codeEntityReference>T:Renci.SshClient.ConnectionInfo</codeEntityReference> objet to provide connection information.
</para>
<code language="cs">
var connectionInfo = new PasswordConnectionInfo("host", "username", "password");
using (var client = new SshClient(connectionInfo))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
<listItem>
<para>Try to connect to the host within 30 seconds.</para>
<code language="cs">
var connectionInfo = new PasswordConnectionInfo("host", "username", "password");
connectionInfo.Timeout = TimeSpan.FromSeconds(30);
using (var client = new SshClient(connectionInfo))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
</list>
</codeExample>
</content>
</section>
<section>
<title>Connect using private key file.</title>
<content>
<para>Following examples show how to connect using one or many private keys wich can be encrypted with passphrase.</para>
<codeExample>
<list class="ordered">
<listItem>
<para>Connecting using private key file without providing a passphrase</para>
<code language="cs">
using (var client = new SshClient("host", "username", new PrivateKeyFile(File.OpenRead(@"private.key"))))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
<listItem>
<para>Connecting using private key file without providing a passphrase</para>
<code language="cs">
using (var client = new SshClient("host", "username", new PrivateKeyFile(File.OpenRead(@"private.key"))))
{
client.Connect();
client.Disconnect();
}
</code>
</listItem>
</list>
</codeExample>
</content>
</section>
<section>
<title>Connect using keyboar interactive method.</title>
<content>
<para>Examples of how to use keyboard interactive method to authenticate users.</para>
<codeExample>
<list class="ordered">
<listItem>
<para>Example description</para>
<code language="cs">
</code>
</listItem>
</list>
</codeExample>
</content>
</section>
<section>
<title>Display server propmt to the user.</title>
<content>
<para>Description</para>
<codeExample>
<list class="ordered">
<listItem>
<para>Example description</para>
<code language="cs">
</code>
</listItem>
</list>
</codeExample>
</content>
</section>
<section>
<title>Change user password when logging in.</title>
<content>
<para>Description</para>
<codeExample>
<list class="ordered">
<listItem>
<para>Example description</para>
<code language="cs">
</code>
</listItem>
</list>
</codeExample>
</content>
</section>
<relatedTopics>
<relatedTopics>
<codeEntityReference>T:Renci.SshClient.PrivateKeyConnectionInfo</codeEntityReference>
<codeEntityReference>T:Renci.SshClient.PasswordConnectionInfo</codeEntityReference>
<codeEntityReference>T:Renci.SshClient.SshClient</codeEntityReference>
<codeEntityReference>M:Renci.SshClient.SshBaseClient.Connect</codeEntityReference>
</relatedTopics>
</relatedTopics>
</developerOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/HowTo.Sftp.aml
+50
View File
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="e9b8aa39-6ebc-4b75-83a5-497a280d77b7" revisionNumber="1">
<developerOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<para>Required introduction</para>
</introduction>
<!-- <inThisSection>Optional description of content in this section</inThisSection> -->
<!-- <reference>Optional reference section</reference> -->
<!-- <relatedSections>Optional related sections info</relatedSections> -->
<!-- <externalResources>Optional external resources section</externalResources> -->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/HowTo.SshCommand.Run.aml
+68
View File
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="41498c7b-6dcb-46d5-88f5-0b156c08516d" revisionNumber="1">
<developerHowToDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<summary>
<para>Optional summary abstract</para>
</summary>
<introduction>
<para>Required introduction</para>
</introduction>
<!-- Optional procedures followed by optional code example but must have
at least one procedure or code example -->
<procedure>
<title>Procedure title</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<conclusion>Optional conclusion</conclusion>
</procedure>
<codeExample>Optional code example</codeExample>
<!-- <buildInstructions>Optional instructions for building a
code example.</buildInstructions> -->
<robustProgramming>Optional discussion of error handling and other
issues related to writing solid code.</robustProgramming>
<security>Optional discussion of security issues.</security>
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerHowToDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/HowTo.SshCommand.aml
+50
View File
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="43c9b2df-fd0c-4041-9680-54dc908324db" revisionNumber="1">
<developerOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<para>Required introduction</para>
</introduction>
<!-- <inThisSection>Optional description of content in this section</inThisSection> -->
<!-- <reference>Optional reference section</reference> -->
<!-- <relatedSections>Optional related sections info</relatedSections> -->
<!-- <externalResources>Optional external resources section</externalResources> -->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/HowTo.aml
+50
View File
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="a07c9037-64e3-4e09-b460-8a68d95c1131" revisionNumber="1">
<developerOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<para>Required introduction</para>
</introduction>
<!-- <inThisSection>Optional description of content in this section</inThisSection> -->
<!-- <reference>Optional reference section</reference> -->
<!-- <relatedSections>Optional related sections info</relatedSections> -->
<!-- <externalResources>Optional external resources section</externalResources> -->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/Introduction.aml
+48
View File
@@ -0,0 +1,48 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="af377286-3f01-4c15-8b79-66aac14561f7" revisionNumber="1">
<developerOrientationDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<summary>
<para>Optional summary abstract</para>
</summary>
<introduction>
<para>Required introduction</para>
</introduction>
<inThisSection>Optional description of content in this section</inThisSection>
<!-- <reference>Optional reference section</reference> -->
<!-- <relatedSections>Optional related sections info</relatedSections> -->
<externalResources>Optional external resources section</externalResources>
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>SHFB on CodePlex</linkText>
<linkAlternateText>Go to CodePlex</linkAlternateText>
<linkUri>http://shfb.codeplex.com</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerOrientationDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Content/Reference.aml
+16
View File
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<topic id="8e553ec7-3a42-4bd1-9252-b9b3c957b454" revisionNumber="1">
<codeEntityDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- NOTE: This is similar to the API reference documentation which is
produced by the reference build. You should probably just use that
instead of this. -->
<assembly>
<assemblyName>Assembly name</assemblyName>
</assembly>
<codeEntities>
<codeEntity>
<codeEntityReference>API member ID</codeEntityReference>
</codeEntity>
</codeEntities>
</codeEntityDocument>
</topic>
Renci.SshClient/Renci.SshClient/Documentation/Renci.SshClient.content
+17
View File
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<Topics>
<Topic id="af377286-3f01-4c15-8b79-66aac14561f7" visible="True" />
<Topic id="a07c9037-64e3-4e09-b460-8a68d95c1131" visible="True" title="How To">
<Topic id="43c9b2df-fd0c-4041-9680-54dc908324db" visible="True" title="Use SshCommand">
<Topic id="41498c7b-6dcb-46d5-88f5-0b156c08516d" visible="True" title="How to run SSH command" />
</Topic>
<Topic id="e9b8aa39-6ebc-4b75-83a5-497a280d77b7" visible="True" title="Use Sftp" />
<Topic id="fee6a616-6282-4419-a517-7c33c56158ee" visible="True" title="Connect" />
</Topic>
<Topic id="96a68c17-9f73-4c26-816e-bfce16366094" visible="True">
<Topic id="2c568137-b080-45b0-86d0-cd157e9d0604" visible="True" title="Adding new encryption" />
<Topic id="ec6dd28e-c788-4812-89ae-53a26420e50b" visible="True" title="Adding new authentication method" />
<Topic id="ea611b0c-8312-433b-88b1-d64a7222566b" visible="True" title="Adding new hash algorithm" />
</Topic>
<Topic id="8e553ec7-3a42-4bd1-9252-b9b3c957b454" visible="True" apiParentMode="InsertAsChild" />
</Topics>
Renci.SshClient/Renci.SshClient/Documentation/SshClient.shfbproj
+133
View File
@@ -0,0 +1,133 @@
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="3.5">
<PropertyGroup>
<!-- The configuration and platform will be used to determine which
assemblies to include from solution and project documentation
sources -->
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{0b73772a-c19f-4218-bd92-efa8d5f2ddd3}</ProjectGuid>
<SHFBSchemaVersion>1.9.0.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
<RootNamespace>Documentation</RootNamespace>
<Name>Documentation</Name>
<!-- SHFB properties -->
<OutputPath>.\Help\</OutputPath>
<HtmlHelpName>SshClient</HtmlHelpName>
<Language>en-US</Language>
<DocumentationSources>
<DocumentationSource sourceFile="..\Renci.SshClient.csproj" xmlns="" />
</DocumentationSources>
<FrameworkVersion>4.0.30319</FrameworkVersion>
<HelpTitle>A Ssh.Net Client Documentation</HelpTitle>
<FeedbackEMailAddress>olegkap%40gmail.com</FeedbackEMailAddress>
<CopyrightHref>http://sshnet.codeplex.com</CopyrightHref>
<MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, Namespace, TypeParameter</MissingTags>
<ComponentConfigurations>
<ComponentConfig id="Cached Framework Comments Index Data" enabled="True" xmlns="">
<component id="Cached Framework Comments Index Data" type="SandcastleBuilder.Components.CachedCopyFromIndexComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
<index name="comments" value="/doc/members/member" key="@name" cache="100">
{@CachedFrameworkCommentList}
{@CommentFileList}
</index>
<copy name="comments" source="*" target="/document/comments" />
</component>
</ComponentConfig>
<ComponentConfig id="Cached MSDN URL References" enabled="True" xmlns="">
<component id="Cached MSDN URL References" type="SandcastleBuilder.Components.CachedResolveReferenceLinksComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll" locale="{@Locale}" linkTarget="{@SdkLinkTarget}">
<helpOutput format="HtmlHelp1">
<cache filename="{@LocalDataFolder}Cache\MsdnUrl.cache" />
<targets base="{@SandcastlePath}Data\Reflection" recurse="true" files="*.xml" type="{@HtmlSdkLinkType}" />
<targets files="reflection.xml" type="Local" />
</helpOutput>
<helpOutput format="MSHelp2">
<cache filename="{@LocalDataFolder}Cache\MsdnUrl.cache" />
<targets base="{@SandcastlePath}Data\Reflection" recurse="true" files="*.xml" type="{@MSHelp2SdkLinkType}" />
<targets files="reflection.xml" type="Index" />
</helpOutput>
<helpOutput format="MSHelpViewer">
<cache filename="{@LocalDataFolder}Cache\MsdnUrl.cache" />
<targets base="{@SandcastlePath}Data\Reflection" recurse="true" files="*.xml" type="{@MSHelpViewerSdkLinkType}" />
<targets files="reflection.xml" type="Id" />
</helpOutput>
<helpOutput format="Website">
<cache filename="{@LocalDataFolder}Cache\MsdnUrl.cache" />
<targets base="{@SandcastlePath}Data\Reflection" recurse="true" files="*.xml" type="{@WebsiteSdkLinkType}" />
<targets files="reflection.xml" type="Local" />
</helpOutput>
</component>
</ComponentConfig>
<ComponentConfig id="Cached Reflection Index Data" enabled="True" xmlns="">
<component id="Cached Reflection Index Data" type="SandcastleBuilder.Components.CachedCopyFromIndexComponent" assembly="{@SHFBFolder}SandcastleBuilder.Components.dll">
<index name="reflection" value="/reflection/apis/api" key="@id" cache="10">
<cache base="{@SandcastlePath}Data\Reflection" recurse="true" files="*.xml" cacheFile="{@LocalDataFolder}Cache\Reflection.cache" />
<data files="reflection.xml" />
</index>
<copy name="reflection" source="*" target="/document/reference" />
</component>
</ComponentConfig>
</ComponentConfigurations>
<HelpAttributes>
<HelpAttribute name="DocSet" value="{@HtmlHelpName}" xmlns="" />
<HelpAttribute name="DocSet" value="NetFramework" xmlns="" />
<HelpAttribute name="TargetOS" value="Windows" xmlns="" />
</HelpAttributes>
<NamespaceSummaries>
<NamespaceSummaryItem name="Renci.SshClient.Common" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Compression" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Messages" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Messages.Authentication" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Messages.Connection" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Messages.Sftp" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Messages.Transport" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Security" isDocumented="False" />
<NamespaceSummaryItem name="Renci.SshClient.Sftp" isDocumented="False" /></NamespaceSummaries>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in
order for Visual Studio to perform the build. The others are optional
common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<ItemGroup>
<ContentLayout Include="Renci.SshClient.content" />
</ItemGroup>
<ItemGroup>
<Folder Include="Content\" />
</ItemGroup>
<ItemGroup>
<None Include="Content\Introduction.aml" />
<None Include="Content\HowTo.aml" />
<None Include="Content\HowTo.Sftp.aml" />
<None Include="Content\HowTo.SshCommand.aml" />
<None Include="Content\HowTo.SshCommand.Run.aml" />
<None Include="Content\Reference.aml" />
<None Include="Content\HowTo.Connect.aml" />
<None Include="Content\HowTo.Connect.UsingPassword.aml" />
<None Include="Content\HowTo.Connect.UsingPrivateKey.aml" />
<None Include="Content\HowTo.Connect.UsingKeyboarInteractive.aml" />
<None Include="Content\HowTo.Connect.GettingServerPrompt.aml" />
<None Include="Content\HowTo.Connect.ChangePassword.aml" />
<None Include="Content\Extensibility.aml" />
<None Include="Content\Extensibility.AddEncryption.aml" />
<None Include="Content\Extensibility.AddAuthenticationMethod.aml" />
<None Include="Content\Extensibility.AddHashAlgorithm.aml" />
</ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>
Renci.SshClient/Renci.SshClient/Renci.SshClient.csproj
+20 -1
View File
@@ -25,6 +25,7 @@
<DefineConstants>DEBUG;TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<DocumentationFile>bin\Debug\Renci.SshClient.XML</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
@@ -33,6 +34,7 @@
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<DocumentationFile>bin\Release\Renci.SshClient.XML</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'DebugNoTimeout|AnyCPU'">
<DebugSymbols>true</DebugSymbols>
@@ -49,6 +51,7 @@
<CodeAnalysisIgnoreBuiltInRuleSets>false</CodeAnalysisIgnoreBuiltInRuleSets>
<CodeAnalysisRuleDirectories>;C:\Program Files (x86)\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\FxCop\\Rules</CodeAnalysisRuleDirectories>
<CodeAnalysisIgnoreBuiltInRules>false</CodeAnalysisIgnoreBuiltInRules>
<DocumentationFile>bin\DebugNoTimeout\Renci.SshClient.XML</DocumentationFile>
</PropertyGroup>
<ItemGroup>
<Reference Include="System" />
@@ -131,7 +134,7 @@
<Compile Include="Sftp\SftpFileAttributes.cs" />
<Compile Include="Sftp\SftpSession.cs" />
<Compile Include="Sftp\UploadFileCommand.cs" />
<Compile Include="SshBaseClient.cs" />
<Compile Include="BaseClient.cs" />
<Compile Include="SshCommand.cs" />
<Compile Include="MessageEventArgs.cs" />
<Compile Include="ChannelAsyncResult.cs" />
@@ -274,6 +277,22 @@
<Compile Include="SshClient.cs" />
<Compile Include="UserAuthentication.cs" />
</ItemGroup>
<ItemGroup />
<ItemGroup>
<None Include="Documentation\Content\Extensibility.AddAuthenticationMethod.aml" />
<None Include="Documentation\Content\Extensibility.AddEncryption.aml" />
<None Include="Documentation\Content\Extensibility.AddHashAlgorithm.aml" />
<None Include="Documentation\Content\Extensibility.aml" />
<None Include="Documentation\Content\HowTo.aml" />
<None Include="Documentation\Content\HowTo.Connect.aml" />
<None Include="Documentation\Content\HowTo.Sftp.aml" />
<None Include="Documentation\Content\HowTo.SshCommand.aml" />
<None Include="Documentation\Content\HowTo.SshCommand.Run.aml" />
<None Include="Documentation\Content\Introduction.aml" />
<None Include="Documentation\Content\Reference.aml" />
<None Include="Documentation\Renci.SshClient.content" />
<Content Include="Documentation\SshClient.shfbproj" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
Other similar extension points exist, see Microsoft.Common.targets.
Renci.SshClient/Renci.SshClient/SftpClient.cs
+1 -1
View File
@@ -9,7 +9,7 @@ namespace Renci.SshClient
/// <summary>
///
/// </summary>
public class SftpClient : SshBaseClient
public class SftpClient : BaseClient
{
/// <summary>
/// Holds SftpSession instance that used to communicate to the SFTP server
Renci.SshClient/Renci.SshClient/SshClient.cs
+1 -1
View File
@@ -5,7 +5,7 @@ using System.Collections.ObjectModel;
namespace Renci.SshClient
{
public class SshClient : SshBaseClient
public class SshClient : BaseClient
{
/// <summary>
/// Holds the list of forwarded ports