ps-adcompleters

0.1

en-us/ps-adcompleters-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>Export-ADCompleterConfig</command:name>

      <command:verb>Export</command:verb>

      <command:noun>ADCompleterConfig</command:noun>

      <maml:description>

        <maml:para>Saves the current configuration state of `ps-adcompleters`.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Configuration for `ps-adcompleters` is accessed via `$ADCompleterConfig`.  Changes to this are for the current session only unless `Export-ADCompleterConfig` is called.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Export-ADCompleterConfig</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <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>PS C:\&gt; Export-ADCompleterConfig</dev:code>

        <dev:remarks>

          <maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Set-ShowDisabledADUsers</command:name>

      <command:verb>Set</command:verb>

      <command:noun>ShowDisabledADUsers</command:noun>

      <maml:description>

        <maml:para>Enable or disable the display of disabled user accounts in completion.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>When `ShowDisabled` is set to false, do not include disabled user accounts in list of completion results.</maml:para>

      <maml:para>When set to true display them, the default fancy completion of users will flag disabled users with `*` before their names to distinguish them from enabled ones.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-ShowDisabledADUsers</maml:name>

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

          <maml:name>enable</maml:name>

          <maml:Description>

            <maml:para></maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>Boolean</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="0" aliases="none">

        <maml:name>enable</maml:name>

        <maml:Description>

          <maml:para></maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>Boolean</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>PS C:\&gt; Set-ShowDisabledADUsers $true</dev:code>

        <dev:remarks>

          <maml:para>Enables the display of disabled users.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Set-UseFancyCompleters</command:name>

      <command:verb>Set</command:verb>

      <command:noun>UseFancyCompleters</command:noun>

      <maml:description>

        <maml:para>Enable or disable the use of more detailed completion.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>With `UseFancyCompleters` set to false, only display sAMAccountName when providing completion suggestions.</maml:para>

      <maml:para>With it set to true provide the values of `$ADCompleterConfig.FancyCompleters` for ListText and ToolTip (as appropriate for users or groups) to their respective completion methods.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-UseFancyCompleters</maml:name>

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

          <maml:name>enable</maml:name>

          <maml:Description>

            <maml:para></maml:para>

          </maml:Description>

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

          <dev:type>

            <maml:name>Boolean</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="0" aliases="none">

        <maml:name>enable</maml:name>

        <maml:Description>

          <maml:para></maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>Boolean</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>PS C:\&gt; Set-UseFancyCompleters $true</dev:code>

        <dev:remarks>

          <maml:para>Displays fancy completion.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Show-ADCompleterConfiguration</command:name>

      <command:verb>Show</command:verb>

      <command:noun>ADCompleterConfiguration</command:noun>

      <maml:description>

        <maml:para>Prints the current configuration.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Prints the current configuration for `ps-adcompleters`.  This is equivalent to calling `$ADCompleterConfig` but the latter also allows for modification.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Show-ADCompleterConfiguration</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <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>PS C:\&gt; Show-ADCompleterConfiguration

Name                           Value

----                           -----

ShowDisabled                   True

UseFancyCompleters             True

FancyCompleters                {group, user}</dev:code>

        <dev:remarks>

          <maml:para>Prints current configuration.  Details of fancy completers are under the `FancyCompleters` object.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>