online_help()

void datrw::formatmodifiers::online_help

(

std::ostream &

os

)

Provide online help on modifiers.

Parameters

os	output stream to which online help should be written

Definition at line 76 of file formatmodifier.cc.

Referenced by main(), and datrw::online_help().

    {
      os << "format modifiers" << std::endl;
      os << "----------------" << std::endl;
      os << 
        "Some I/O streams support format modifiers. These can be used to\n"
        "control the behaviour of the specific I/O stream. The modifiers\n"
        "are passed through a string to the I/O stream. Each modifier\n"
        "consists of a keyword and an optional parameter string. Several\n"
        "modifiers can be concatenated being separated by a colon (:).\n"
        "Keyword and parameter are separated by an equal sign (=).\n"
        "If the program takes format identifiers as string values,\n"
        "format modifiers usually can be appended to the format ID with\n"
        "a separating colon in between.\n"
        "\n"
        "Example: To read a seife format file, using 4.7.2011 as the day\n"
        "of recording and \"BFO\" as recording station, you could use\n"
        "\n"
        "  seife:date=2011/7/4:station=BFO\n"
        "\n"
        "to specify the input format.";
      os << std::endl;
    } // void online_help(std::ostream& os)

Here is the caller graph for this function: