Professional IronPython

LISTINg 10-4 
(continued)
548592c10.indd 202
2/24/10 12:48:30 PM
www.finebook.ir

---

Understanding the Command Line
 
❘
 
203
FIgURE 10-4: 
Parsing arguments produces the same results in .NET as it does with Python.
Providing Command Line Help
Your command line application won’t have a user interface — just a command. While some people 
can figure out graphical applications by pointing here and clicking there, figuring out a command 
line application without help is nearly impossible. The methods used to understand an undocumented 
command line application are exotic and usually require advanced debugging techniques, time spent in 
the registry, lots of research online, and more than a little luck. If you seriously expect someone to use 
your command line application, you must provide help.
Unlike a graphical application, you won’t need tons of text and screenshots to document most 
command line applications. All you really need is a little text that’s organized in a certain manner. 
Most command line applications use the same help format, which makes them easier to understand 
and use. However, not all command line applications provide all the help they really need. In order 
to provide your command line application with superior help, you need to consider the five follow-
ing elements:
➤
Application description
➤
Application calling syntax
➤
➤
Command line switch summary and description
➤
➤
Usage examples
➤
➤
(Optional) Other elements
➤
➤
The following sections describe all these elements and help you understand why they’re important. 
Of course, every command line application is different, so you’ll want to customize the suggestions 
in the following sections to meet your particular needs. The point is, you must provide the user with 
help of some kind.