Passphraser

1.0.4

en-US/Passphraser-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>New-Passphrase</command:name>

      <command:verb>New</command:verb>

      <command:noun>Passphrase</command:noun>

      <maml:description>

        <maml:para>Generates a new random passphrase.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Generates a new random passphrase. Choose how many words, if you want to include an uppercase word, if you want to include numbers and/or special characters and how many of each.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-Passphrase</maml:name>

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

          <maml:name>AmountOfWords</maml:name>

          <maml:Description>

            <maml:para>Amount of words to get</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>3</dev:defaultValue>

        </command:parameter>

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

          <maml:name>AmountOfNumbers</maml:name>

          <maml:Description>

            <maml:para>Amount of numbers to include</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>1</dev:defaultValue>

        </command:parameter>

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

          <maml:name>AmountOfSpecials</maml:name>

          <maml:Description>

            <maml:para>Amount of special characters to include</maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>1</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Separator</maml:name>

          <maml:Description>

            <maml:para>Separator to use between words</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>" " (whitespace)</dev:defaultValue>

        </command:parameter>

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

          <maml:name>AsObject</maml:name>

          <maml:Description>

            <maml:para>Return passphrase as passphrase object</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Confirm</maml:name>

          <maml:Description>

            <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>IncludeNumbers</maml:name>

          <maml:Description>

            <maml:para>Includes numbers</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>IncludeSpecials</maml:name>

          <maml:Description>

            <maml:para>Include special characters</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>IncludeUppercase</maml:name>

          <maml:Description>

            <maml:para>Include an uppercase word</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>WhatIf</maml:name>

          <maml:Description>

            <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>AmountOfNumbers</maml:name>

        <maml:Description>

          <maml:para>Amount of numbers to include</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>1</dev:defaultValue>

      </command:parameter>

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

        <maml:name>AmountOfSpecials</maml:name>

        <maml:Description>

          <maml:para>Amount of special characters to include</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>1</dev:defaultValue>

      </command:parameter>

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

        <maml:name>AmountOfWords</maml:name>

        <maml:Description>

          <maml:para>Amount of words to get</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>3</dev:defaultValue>

      </command:parameter>

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

        <maml:name>AsObject</maml:name>

        <maml:Description>

          <maml:para>Return passphrase as passphrase object</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Confirm</maml:name>

        <maml:Description>

          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>IncludeNumbers</maml:name>

        <maml:Description>

          <maml:para>Includes numbers</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>IncludeSpecials</maml:name>

        <maml:Description>

          <maml:para>Include special characters</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>IncludeUppercase</maml:name>

        <maml:Description>

          <maml:para>Include an uppercase word</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Separator</maml:name>

        <maml:Description>

          <maml:para>Separator to use between words</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>" " (whitespace)</dev:defaultValue>

      </command:parameter>

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

        <maml:name>WhatIf</maml:name>

        <maml:Description>

          <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</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.String or 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>PS C:\&gt; New-Passphrase</dev:code>

        <dev:remarks>

          <maml:para>Generates a new all lowercase passphrase with default values, 3 words and whitespace as separator.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; New-Passphrase -Separator "-"</dev:code>

        <dev:remarks>

          <maml:para>Generates a new all lowercase passphrase with 3 words and dash (-) as separator.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; New-Passphrase -AmountOfWords 5 -Separator "-" -IncludeNumbers -AmountOfNumbers 2 -IncludeUppercase | clip</dev:code>

        <dev:remarks>

          <maml:para>Generates a new passphrase with 5 words, dash (-) as separator with 2 numbers, one uppercase word and pipes the ouput to clipboard.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; New-Passphrase -AmountOfWords 5 -Separator "-" -IncludeNumbers -AmountOfNumbers 2 -IncludeUppercase -IncludeSpecials -AmountOfSpecials 2</dev:code>

        <dev:remarks>

          <maml:para>Generates a new passphrase with 5 words, dash (-) as separator with 2 numbers, 2 special characters and one uppercase word.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; New-Passphrase -AmountOfWords 5 -Separator "-" -IncludeNumbers -AmountOfNumbers 2 -IncludeUppercase -IncludeSpecials -AmountOfSpecials 2 -AsObject</dev:code>

        <dev:remarks>

          <maml:para>Generates a new passphrase object with 5 words, dash (-) as separator with 2 numbers, 2 special characters and one uppercase word. This object can then be manipulated further.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>