vibe.d beta banner
get vibe.d
0.7.30

Function finalizeCommandLineOptions

Checks for unrecognized command line options and display a help screen.

This function is called automatically from vibe.appmain and from vibe.core.core.runApplication to check for correct command line usage. It will print a help screen in case of unrecognized options.

Prototype

bool finalizeCommandLineOptions(
  string[]* args_out = null
);

Parameters

NameDescription
args_out Optional parameter for storing any arguments not handled by any readOption call. If this is left to null, an error will be triggered whenever unhandled arguments exist.

Returns

If "--help" was passed, the function returns false. In all other cases either true is returned or an exception is thrown.

Authors

Sönke Ludwig, Vladimir Panteleev

Copyright

© 2012 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.