Remove Mono.GetOptions
[mono.git] / mcs / class / Mono.GetOptions / Documentation / en / Mono.GetOptions / Options.xml
1 <Type Name="Options" FullName="Mono.GetOptions.Options">
2   <TypeSignature Language="C#" Value="public class Options" Maintainer="auto" />
3   <AssemblyInfo>
4     <AssemblyName>Mono.GetOptions</AssemblyName>
5     <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 79 15 99 77 D2 D0 3A 8E 6B EA 7A 2E 74 E8 D1 AF CC 93 E8 85 19 74 95 2B B4 80 A1 2C 91 34 47 4D 04 06 24 47 C3 7E 0E 68 C0 80 53 6F CF 3C 3F BE 2F F9 C9 79 CE 99 84 75 E5 06 E8 CE 82 DD 5B 0F 35 0D C1 0E 93 BF 2E EE CF 87 4B 24 77 0C 50 81 DB EA 74 47 FD DA FA 27 7B 22 DE 47 D6 FF EA 44 96 74 A4 F9 FC CF 84 D1 50 69 08 93 80 28 4D BD D3 5F 46 CD FF 12 A1 BD 78 E4 EF 00 65 D0 16 DF]</AssemblyPublicKey>
6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
8   </AssemblyInfo>
9   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
10   <Base>
11     <BaseTypeName>System.Object</BaseTypeName>
12   </Base>
13   <Interfaces />
14   <Docs>
15     <summary>To be added</summary>
16     <remarks>To be added</remarks>
17   </Docs>
18   <Members>
19     <Member MemberName=".ctor">
20       <MemberSignature Language="C#" Value="public Options ();" />
21       <MemberType>Constructor</MemberType>
22       <ReturnValue />
23       <Parameters />
24       <Docs>
25         <summary>To be added</summary>
26         <remarks>To be added</remarks>
27       </Docs>
28       <AssemblyInfo>
29         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
30         <AssemblyVersion>2.0.0.0</AssemblyVersion>
31       </AssemblyInfo>
32     </Member>
33     <Member MemberName=".ctor">
34       <MemberSignature Language="C#" Value="public Options (string[] args);" />
35       <MemberType>Constructor</MemberType>
36       <Parameters>
37         <Parameter Name="args" Type="System.String[]" />
38       </Parameters>
39       <Docs>
40         <param name="args">To be added.</param>
41         <summary>To be added.</summary>
42         <remarks>To be added.</remarks>
43       </Docs>
44       <AssemblyInfo>
45         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
46         <AssemblyVersion>2.0.0.0</AssemblyVersion>
47       </AssemblyInfo>
48     </Member>
49     <Member MemberName=".ctor">
50       <MemberSignature Language="C#" Value="public Options (string[] args, Mono.GetOptions.OptionsParsingMode parsingMode, bool breakSingleDashManyLettersIntoManyOptions, bool endOptionProcessingWithDoubleDash, bool dontSplitOnCommas);" />
51       <MemberType>Constructor</MemberType>
52       <Parameters>
53         <Parameter Name="args" Type="System.String[]" />
54         <Parameter Name="parsingMode" Type="Mono.GetOptions.OptionsParsingMode" />
55         <Parameter Name="breakSingleDashManyLettersIntoManyOptions" Type="System.Boolean" />
56         <Parameter Name="endOptionProcessingWithDoubleDash" Type="System.Boolean" />
57         <Parameter Name="dontSplitOnCommas" Type="System.Boolean" />
58       </Parameters>
59       <Docs>
60         <param name="args">To be added.</param>
61         <param name="parsingMode">To be added.</param>
62         <param name="breakSingleDashManyLettersIntoManyOptions">To be added.</param>
63         <param name="endOptionProcessingWithDoubleDash">To be added.</param>
64         <param name="dontSplitOnCommas">To be added.</param>
65         <summary>To be added.</summary>
66         <remarks>To be added.</remarks>
67       </Docs>
68       <AssemblyInfo>
69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
71       </AssemblyInfo>
72     </Member>
73     <Member MemberName=".ctor">
74       <MemberSignature Language="C#" Value="public Options (string[] args, Mono.GetOptions.OptionsParsingMode parsingMode, bool breakSingleDashManyLettersIntoManyOptions, bool endOptionProcessingWithDoubleDash, bool dontSplitOnCommas, Mono.GetOptions.ErrorReporter reportError);" />
75       <MemberType>Constructor</MemberType>
76       <Parameters>
77         <Parameter Name="args" Type="System.String[]" />
78         <Parameter Name="parsingMode" Type="Mono.GetOptions.OptionsParsingMode" />
79         <Parameter Name="breakSingleDashManyLettersIntoManyOptions" Type="System.Boolean" />
80         <Parameter Name="endOptionProcessingWithDoubleDash" Type="System.Boolean" />
81         <Parameter Name="dontSplitOnCommas" Type="System.Boolean" />
82         <Parameter Name="reportError" Type="Mono.GetOptions.ErrorReporter" />
83       </Parameters>
84       <Docs>
85         <param name="args">To be added.</param>
86         <param name="parsingMode">To be added.</param>
87         <param name="breakSingleDashManyLettersIntoManyOptions">To be added.</param>
88         <param name="endOptionProcessingWithDoubleDash">To be added.</param>
89         <param name="dontSplitOnCommas">To be added.</param>
90         <param name="reportError">To be added.</param>
91         <summary>To be added.</summary>
92         <remarks>To be added.</remarks>
93       </Docs>
94       <AssemblyInfo>
95         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
96         <AssemblyVersion>2.0.0.0</AssemblyVersion>
97       </AssemblyInfo>
98     </Member>
99     <Member MemberName="AdditionalBannerInfo">
100       <MemberSignature Language="C#" Value="public virtual string AdditionalBannerInfo { get; }" />
101       <MemberType>Property</MemberType>
102       <ReturnValue>
103         <ReturnType>System.String</ReturnType>
104       </ReturnValue>
105       <Docs>
106         <summary>To be added.</summary>
107         <value>To be added.</value>
108         <remarks>To be added.</remarks>
109       </Docs>
110       <AssemblyInfo>
111         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
112         <AssemblyVersion>2.0.0.0</AssemblyVersion>
113       </AssemblyInfo>
114     </Member>
115     <Member MemberName="BreakSingleDashManyLettersIntoManyOptions">
116       <MemberSignature Language="C#" Value="public bool BreakSingleDashManyLettersIntoManyOptions;" />
117       <MemberType>Field</MemberType>
118       <ReturnValue>
119         <ReturnType>System.Boolean</ReturnType>
120       </ReturnValue>
121       <Parameters>
122       </Parameters>
123       <Docs>
124         <summary>To be added</summary>
125         <remarks>To be added</remarks>
126       </Docs>
127       <AssemblyInfo>
128         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
129         <AssemblyVersion>2.0.0.0</AssemblyVersion>
130       </AssemblyInfo>
131     </Member>
132     <Member MemberName="DebuggingOfOptions">
133       <MemberSignature Language="C#" Value="public bool DebuggingOfOptions { set; get; }" />
134       <MemberType>Property</MemberType>
135       <AssemblyInfo>
136         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
137         <AssemblyVersion>2.0.0.0</AssemblyVersion>
138       </AssemblyInfo>
139       <Attributes>
140         <Attribute>
141           <AttributeName>Mono.GetOptions.Option("Show debugging info while processing options", ~, "debugoptions", SecondLevelHelp=true)</AttributeName>
142         </Attribute>
143       </Attributes>
144       <ReturnValue>
145         <ReturnType>System.Boolean</ReturnType>
146       </ReturnValue>
147       <Docs>
148         <summary>To be added.</summary>
149         <value>To be added.</value>
150         <remarks>To be added.</remarks>
151       </Docs>
152     </Member>
153     <Member MemberName="DefaultArgumentProcessor">
154       <MemberSignature Language="C#" Value="public virtual void DefaultArgumentProcessor (string argument);" />
155       <MemberType>Method</MemberType>
156       <ReturnValue>
157         <ReturnType>System.Void</ReturnType>
158       </ReturnValue>
159       <Parameters>
160         <Parameter Name="argument" Type="System.String" />
161       </Parameters>
162       <Docs>
163         <param name="argument">To be added.</param>
164         <summary>To be added.</summary>
165         <remarks>To be added.</remarks>
166       </Docs>
167       <AssemblyInfo>
168         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
169         <AssemblyVersion>2.0.0.0</AssemblyVersion>
170       </AssemblyInfo>
171       <Attributes>
172         <Attribute>
173           <AttributeName>Mono.GetOptions.ArgumentProcessor</AttributeName>
174         </Attribute>
175       </Attributes>
176     </Member>
177     <Member MemberName="DoAbout">
178       <MemberSignature Language="C#" Value="public virtual Mono.GetOptions.WhatToDoNext DoAbout ();" />
179       <MemberType>Method</MemberType>
180       <ReturnValue>
181         <ReturnType>Mono.GetOptions.WhatToDoNext</ReturnType>
182       </ReturnValue>
183       <Parameters />
184       <Docs>
185         <summary>To be added</summary>
186         <returns>a <see cref="T:Mono.GetOptions.WhatToDoNext" /></returns>
187         <remarks>To be added</remarks>
188       </Docs>
189       <AssemblyInfo>
190         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
191         <AssemblyVersion>2.0.0.0</AssemblyVersion>
192       </AssemblyInfo>
193       <Attributes>
194         <Attribute>
195           <AttributeName>Mono.GetOptions.Option("Display version and licensing information", V, "version")</AttributeName>
196         </Attribute>
197       </Attributes>
198     </Member>
199     <Member MemberName="DoHelp">
200       <MemberSignature Language="C#" Value="public virtual Mono.GetOptions.WhatToDoNext DoHelp ();" />
201       <MemberType>Method</MemberType>
202       <ReturnValue>
203         <ReturnType>Mono.GetOptions.WhatToDoNext</ReturnType>
204       </ReturnValue>
205       <Parameters />
206       <Docs>
207         <summary>To be added</summary>
208         <returns>a <see cref="T:Mono.GetOptions.WhatToDoNext" /></returns>
209         <remarks>To be added</remarks>
210       </Docs>
211       <AssemblyInfo>
212         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
213         <AssemblyVersion>2.0.0.0</AssemblyVersion>
214       </AssemblyInfo>
215       <Attributes>
216         <Attribute>
217           <AttributeName>Mono.GetOptions.Option("Show this help list", ?, "help")</AttributeName>
218         </Attribute>
219       </Attributes>
220     </Member>
221     <Member MemberName="DoHelp2">
222       <MemberSignature Language="C#" Value="public virtual Mono.GetOptions.WhatToDoNext DoHelp2 ();" />
223       <MemberType>Method</MemberType>
224       <ReturnValue>
225         <ReturnType>Mono.GetOptions.WhatToDoNext</ReturnType>
226       </ReturnValue>
227       <Parameters />
228       <Docs>
229         <summary>To be added.</summary>
230         <returns>To be added.</returns>
231         <remarks>To be added.</remarks>
232       </Docs>
233       <AssemblyInfo>
234         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
235         <AssemblyVersion>2.0.0.0</AssemblyVersion>
236       </AssemblyInfo>
237       <Attributes>
238         <Attribute>
239           <AttributeName>Mono.GetOptions.Option("Show an additional help list", "help2")</AttributeName>
240         </Attribute>
241       </Attributes>
242     </Member>
243     <Member MemberName="DontSplitOnCommas">
244       <MemberSignature Language="C#" Value="public bool DontSplitOnCommas;" />
245       <MemberType>Field</MemberType>
246       <ReturnValue>
247         <ReturnType>System.Boolean</ReturnType>
248       </ReturnValue>
249       <Docs>
250         <summary>To be added.</summary>
251         <remarks>To be added.</remarks>
252       </Docs>
253       <AssemblyInfo>
254         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
255         <AssemblyVersion>2.0.0.0</AssemblyVersion>
256       </AssemblyInfo>
257     </Member>
258     <Member MemberName="DoUsage">
259       <MemberSignature Language="C#" Value="public virtual Mono.GetOptions.WhatToDoNext DoUsage ();" />
260       <MemberType>Method</MemberType>
261       <ReturnValue>
262         <ReturnType>Mono.GetOptions.WhatToDoNext</ReturnType>
263       </ReturnValue>
264       <Parameters />
265       <Docs>
266         <summary>To be added</summary>
267         <returns>a <see cref="T:Mono.GetOptions.WhatToDoNext" /></returns>
268         <remarks>To be added</remarks>
269       </Docs>
270       <AssemblyInfo>
271         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
272         <AssemblyVersion>2.0.0.0</AssemblyVersion>
273       </AssemblyInfo>
274       <Attributes>
275         <Attribute>
276           <AttributeName>Mono.GetOptions.Option("Show usage syntax and exit", "usage")</AttributeName>
277         </Attribute>
278       </Attributes>
279     </Member>
280     <Member MemberName="EndOptionProcessingWithDoubleDash">
281       <MemberSignature Language="C#" Value="public bool EndOptionProcessingWithDoubleDash;" />
282       <MemberType>Field</MemberType>
283       <ReturnValue>
284         <ReturnType>System.Boolean</ReturnType>
285       </ReturnValue>
286       <Parameters>
287       </Parameters>
288       <Docs>
289         <summary>To be added</summary>
290         <remarks>To be added</remarks>
291       </Docs>
292       <AssemblyInfo>
293         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
294         <AssemblyVersion>2.0.0.0</AssemblyVersion>
295       </AssemblyInfo>
296     </Member>
297     <Member MemberName="FifthArgument">
298       <MemberSignature Language="C#" Value="public string FifthArgument { get; }" />
299       <MemberType>Property</MemberType>
300       <ReturnValue>
301         <ReturnType>System.String</ReturnType>
302       </ReturnValue>
303       <Docs>
304         <summary>To be added.</summary>
305         <value>To be added.</value>
306         <remarks>To be added.</remarks>
307       </Docs>
308       <AssemblyInfo>
309         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
310         <AssemblyVersion>2.0.0.0</AssemblyVersion>
311       </AssemblyInfo>
312     </Member>
313     <Member MemberName="FirstArgument">
314       <MemberSignature Language="C#" Value="public string FirstArgument { get; }" />
315       <MemberType>Property</MemberType>
316       <ReturnValue>
317         <ReturnType>System.String</ReturnType>
318       </ReturnValue>
319       <Docs>
320         <summary>To be added.</summary>
321         <value>To be added.</value>
322         <remarks>To be added.</remarks>
323       </Docs>
324       <AssemblyInfo>
325         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
326         <AssemblyVersion>2.0.0.0</AssemblyVersion>
327       </AssemblyInfo>
328     </Member>
329     <Member MemberName="FourthArgument">
330       <MemberSignature Language="C#" Value="public string FourthArgument { get; }" />
331       <MemberType>Property</MemberType>
332       <ReturnValue>
333         <ReturnType>System.String</ReturnType>
334       </ReturnValue>
335       <Docs>
336         <summary>To be added.</summary>
337         <value>To be added.</value>
338         <remarks>To be added.</remarks>
339       </Docs>
340       <AssemblyInfo>
341         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
342         <AssemblyVersion>2.0.0.0</AssemblyVersion>
343       </AssemblyInfo>
344     </Member>
345     <Member MemberName="GotNoArguments">
346       <MemberSignature Language="C#" Value="public bool GotNoArguments { get; }" />
347       <MemberType>Property</MemberType>
348       <ReturnValue>
349         <ReturnType>System.Boolean</ReturnType>
350       </ReturnValue>
351       <Docs>
352         <summary>To be added.</summary>
353         <value>To be added.</value>
354         <remarks>To be added.</remarks>
355       </Docs>
356       <AssemblyInfo>
357         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
358         <AssemblyVersion>2.0.0.0</AssemblyVersion>
359       </AssemblyInfo>
360     </Member>
361     <Member MemberName="InitializeOtherDefaults">
362       <MemberSignature Language="C#" Value="protected virtual void InitializeOtherDefaults ();" />
363       <MemberType>Method</MemberType>
364       <ReturnValue>
365         <ReturnType>System.Void</ReturnType>
366       </ReturnValue>
367       <Parameters />
368       <Docs>
369         <summary>To be added.</summary>
370         <remarks>To be added.</remarks>
371       </Docs>
372       <AssemblyInfo>
373         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
374         <AssemblyVersion>2.0.0.0</AssemblyVersion>
375       </AssemblyInfo>
376     </Member>
377     <Member MemberName="ParsingMode">
378       <MemberSignature Language="C#" Value="public Mono.GetOptions.OptionsParsingMode ParsingMode;" />
379       <MemberType>Field</MemberType>
380       <ReturnValue>
381         <ReturnType>Mono.GetOptions.OptionsParsingMode</ReturnType>
382       </ReturnValue>
383       <Parameters>
384       </Parameters>
385       <Docs>
386         <summary>To be added</summary>
387         <remarks>To be added</remarks>
388       </Docs>
389       <AssemblyInfo>
390         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
391         <AssemblyVersion>2.0.0.0</AssemblyVersion>
392       </AssemblyInfo>
393     </Member>
394     <Member MemberName="ProcessArgs">
395       <MemberSignature Language="C#" Value="public void ProcessArgs (string[] args);" />
396       <MemberType>Method</MemberType>
397       <ReturnValue>
398         <ReturnType>System.Void</ReturnType>
399       </ReturnValue>
400       <Parameters>
401         <Parameter Name="args" Type="System.String[]" />
402       </Parameters>
403       <Docs>
404         <param name="args">a <see cref="T:System.String" /></param>
405         <summary>To be added</summary>
406         <remarks>To be added</remarks>
407       </Docs>
408       <AssemblyInfo>
409         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
410         <AssemblyVersion>2.0.0.0</AssemblyVersion>
411       </AssemblyInfo>
412     </Member>
413     <Member MemberName="RemainingArguments">
414       <MemberSignature Language="C#" Value="public string[] RemainingArguments;" />
415       <MemberType>Field</MemberType>
416       <ReturnValue>
417         <ReturnType>System.String[]</ReturnType>
418       </ReturnValue>
419       <Parameters>
420       </Parameters>
421       <Docs>
422         <summary>To be added</summary>
423         <remarks>To be added</remarks>
424       </Docs>
425       <AssemblyInfo>
426         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
427         <AssemblyVersion>2.0.0.0</AssemblyVersion>
428       </AssemblyInfo>
429     </Member>
430     <Member MemberName="ReportError">
431       <MemberSignature Language="C#" Value="public Mono.GetOptions.ErrorReporter ReportError;" />
432       <MemberType>Field</MemberType>
433       <ReturnValue>
434         <ReturnType>Mono.GetOptions.ErrorReporter</ReturnType>
435       </ReturnValue>
436       <Docs>
437         <summary>To be added.</summary>
438         <remarks>To be added.</remarks>
439       </Docs>
440       <AssemblyInfo>
441         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
442         <AssemblyVersion>2.0.0.0</AssemblyVersion>
443       </AssemblyInfo>
444     </Member>
445     <Member MemberName="RunningOnWindows">
446       <MemberSignature Language="C#" Value="public bool RunningOnWindows { get; }" />
447       <MemberType>Property</MemberType>
448       <ReturnValue>
449         <ReturnType>System.Boolean</ReturnType>
450       </ReturnValue>
451       <Docs>
452         <summary>To be added.</summary>
453         <value>To be added.</value>
454         <remarks>To be added.</remarks>
455       </Docs>
456       <AssemblyInfo>
457         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
458         <AssemblyVersion>2.0.0.0</AssemblyVersion>
459       </AssemblyInfo>
460     </Member>
461     <Member MemberName="SecondArgument">
462       <MemberSignature Language="C#" Value="public string SecondArgument { get; }" />
463       <MemberType>Property</MemberType>
464       <ReturnValue>
465         <ReturnType>System.String</ReturnType>
466       </ReturnValue>
467       <Docs>
468         <summary>To be added.</summary>
469         <value>To be added.</value>
470         <remarks>To be added.</remarks>
471       </Docs>
472       <AssemblyInfo>
473         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
474         <AssemblyVersion>2.0.0.0</AssemblyVersion>
475       </AssemblyInfo>
476     </Member>
477     <Member MemberName="ShowBanner">
478       <MemberSignature Language="C#" Value="public void ShowBanner ();" />
479       <MemberType>Method</MemberType>
480       <ReturnValue>
481         <ReturnType>System.Void</ReturnType>
482       </ReturnValue>
483       <Parameters />
484       <Docs>
485         <summary>To be added.</summary>
486         <remarks>To be added.</remarks>
487       </Docs>
488       <AssemblyInfo>
489         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
490         <AssemblyVersion>2.0.0.0</AssemblyVersion>
491       </AssemblyInfo>
492     </Member>
493     <Member MemberName="ThirdArgument">
494       <MemberSignature Language="C#" Value="public string ThirdArgument { get; }" />
495       <MemberType>Property</MemberType>
496       <ReturnValue>
497         <ReturnType>System.String</ReturnType>
498       </ReturnValue>
499       <Docs>
500         <summary>To be added.</summary>
501         <value>To be added.</value>
502         <remarks>To be added.</remarks>
503       </Docs>
504       <AssemblyInfo>
505         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
506         <AssemblyVersion>2.0.0.0</AssemblyVersion>
507       </AssemblyInfo>
508     </Member>
509     <Member MemberName="VerboseParsingOfOptions">
510       <MemberSignature Language="C#" Value="public bool VerboseParsingOfOptions { set; get; }" />
511       <MemberType>Property</MemberType>
512       <ReturnValue>
513         <ReturnType>System.Boolean</ReturnType>
514       </ReturnValue>
515       <Docs>
516         <summary>To be added</summary>
517         <value>a <see cref="T:System.Boolean" /></value>
518         <remarks>To be added</remarks>
519       </Docs>
520       <Attributes>
521         <Attribute>
522           <AttributeName>Mono.GetOptions.Option("Show verbose parsing of options", ., "verbosegetoptions", SecondLevelHelp=true)</AttributeName>
523         </Attribute>
524       </Attributes>
525       <AssemblyInfo>
526         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
527         <AssemblyVersion>2.0.0.0</AssemblyVersion>
528       </AssemblyInfo>
529     </Member>
530   </Members>
531   <Attributes>
532     <Attribute>
533       <AttributeName>System.Obsolete("This class is being obsoleted, we suggest that you use NDesk.Options library instead (ndesk.org/options")</AttributeName>
534     </Attribute>
535   </Attributes>
536 </Type>