[#BloombergLP-balcl-operator_lshift-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balcl.adoc[balcl]::operator<<
:relfileprefix: ../../
:mrdocs:

Write the options and values in `rhs` to `stream` in human‐readable form.

== Synopsis

Declared in `<balcl_commandline.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::ostream&
operator<<(
    std::ostream& stream,
    xref:BloombergLP/balcl/CommandLine.adoc[CommandLine] const& rhs);
----

== Description

Use a (multi‐line) human readable format and return a reference to `stream`. Note that the last line is _not_ terminated by a newline character.

== Return Value

reference to `stream`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| output stream
| *rhs*
| command‐line object to write
|===


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