ps-adcompleters

0.1

en-us/ps-adcompleters-help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
                                <?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>