Dirk

1.0.3

en-US/Dirk-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Install-Dirk</command:name>

      <command:verb>Install</command:verb>

      <command:noun>Dirk</command:noun>

      <maml:description>

        <maml:para>Downloads Dirk scripts repo (Todd) and sets env:DirkRoot</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Downloads Dirk scripts repo (Todd) and sets $env:DirkRoot in $profile.AllUsersAllHosts so other Dirk commands can operate.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Install-Dirk</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Path</maml:name>

          <maml:Description>

            <maml:para>Desired local path for Dirk script repository (Todd)</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Credential</maml:name>

          <maml:Description>

            <maml:para>Credentials for Github to download private Dirk repository (Todd)</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>

          <dev:type>

            <maml:name>PSCredential</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Credential</maml:name>

        <maml:Description>

          <maml:para>Credentials for Github to download private Dirk repository (Todd)</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>

        <dev:type>

          <maml:name>PSCredential</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Path</maml:name>

        <maml:Description>

          <maml:para>Desired local path for Dirk script repository (Todd)</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>&gt; Install-Dirk -Path /path/to/Dirk -Credential (Get-Credential)</dev:code>

        <dev:remarks>

          <maml:para>Prompts for Github Credentials, downloads Todd Repo to '/path/to/Dirk', sets $env:DirkRoot to '/path/to/Dirk'.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 2 --------------------------</maml:title>

        <dev:code>&gt; Install-Dirk -Path /path/to/Dirk</dev:code>

        <dev:remarks>

          <maml:para>Uses $global:GithubCredential, downloads Todd Repo to '/path/to/Dirk', sets $env:DirkRoot to '/path/to/Dirk'.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 3 --------------------------</maml:title>

        <dev:code>&gt; Install-Dirk</dev:code>

        <dev:remarks>

          <maml:para>Uses $global:GithubCredential, downloads Todd Repo to 'c:\lockstep', sets $env:DirkRoot to 'c:\lockstep'.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>