[#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 describing the expected command line to `stderr`.


[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 describing the expected command line to `errorStream`.


[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`.


[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 `errorStream`, using the specified `programName`.


[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..._]#

== Parameters

[cols="1,4"]
|===
| Name| Description
| *errorStream*
| stream to which usage is written
| *programName*
| name of the program in the printed usage
|===


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