[#BloombergLP-balcl-CommandLine-printUsage-0b]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balcl.adoc[balcl]::xref:BloombergLP/balcl/CommandLine.adoc[CommandLine]::printUsage
:relfileprefix: ../../../
:mrdocs:

`printUsage` overloads

== Synopses

Declared in `<balcl_commandline.h>`

Print usage to the specified output `errorStream`, describing what the command line should look like. If `errorStream` is not specified, print usage to `stderr`. Optionally specify `programName` to use as the name of the program in the printed usage. If `programName` is not specified and if `parse` has been previously called successfully, use the first element of the `argv` argument; otherwise, use a default name. This method can be invoked at any time, even before `parse` has been invoked on this object.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balcl/CommandLine/printUsage-0d.adoc[printUsage]() const;
----

[.small]#xref:BloombergLP/balcl/CommandLine/printUsage-0d.adoc[_» more..._]#

Print usage to the specified `errorStream`, describing what the command line should look like.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balcl/CommandLine/printUsage-0f1.adoc[printUsage](std::ostream& errorStream) const;
----

[.small]#xref:BloombergLP/balcl/CommandLine/printUsage-0f1.adoc[_» more..._]#

Print usage to `stderr`, using the specified `programName` as the name of the program in the printed usage.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balcl/CommandLine/printUsage-0f8.adoc[printUsage](std::string_view const& programName) const;
----

[.small]#xref:BloombergLP/balcl/CommandLine/printUsage-0f8.adoc[_» more..._]#

Print usage to the specified `errorStream`, using the specified `programName` as the name of the program in the printed usage.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
xref:BloombergLP/balcl/CommandLine/printUsage-02.adoc[printUsage](
    std::ostream& errorStream,
    std::string_view const& programName) const;
----

[.small]#xref:BloombergLP/balcl/CommandLine/printUsage-02.adoc[_» more..._]#


[.small]#Created with https://www.mrdocs.com[MrDocs]#