commandline icon indicating copy to clipboard operation
commandline copied to clipboard

Formatting of the usage text

Open ajtruckle opened this issue 6 years ago • 2 comments

Is it possible to have more control over how the usage is presented?

For example:

D:\My Programs\2017\OutlookCalIFConsole\OutlookCalIFConsole\bin\Release>outlookcalifconsole -p
OutlookCalIFConsole 1.0.0.0
Copyright c  2017

  -l, --list    Builds a list of available calendars. Eg: -l
                ".\CalendarList.xml"

  -m, --mode    Type of events to add to the calendar. Available modes: mwb.
                Eg: -m mwb

  -p, --path    Path to the events data file. Eg: -p ".\EventsToAdd.xml"

  --help        Display this help screen.```

How can I get it to line up the description nicer? They seem to arbitrarily wrap. I tried using `\n` but then it wrapped to start of the next line.

ajtruckle avatar Sep 05 '17 08:09 ajtruckle

Hmm, I was going to suggest just inheriting from HelpText, but it seems there are no virtual members to override! Perhaps there should be an interface or abstract base class from which we could inherit to provide our own formatting of help text.

I think the HelpText class does provide a mostly good set of defaults, but even I would like to change some details of the output that would be generated by this class.

fourpastmidnight avatar Sep 10 '17 01:09 fourpastmidnight

Yes. The way it is makes it hard to explain the options for some of the switches neatly.

ajtruckle avatar Sep 10 '17 08:09 ajtruckle