help() [1/2]

void datrw::isustream::help ( std::ostream &  os = std::cout )

static

Definition at line 154 of file isustream.cc.

References DATRW_SU_CC_VERSION, datrw::su::SUheader::help(), and datrw::su::subformat::key::strict.

Referenced by datrw::online_help().

  { 
    os <<
      std::endl <<
      "SeismicUn*x reading functions" << std::endl <<
      "-----------------------------" << std::endl <<
      DATRW_SU_CC_VERSION << std::endl <<
      std::endl <<
      "This module provides reading of SeismicUn*x binary data files."
      << std::endl;
    os << std::endl;
    datrw::su::SUheader::help(os);
    os << std::endl;
    os <<
      "Valid format modifiers are:\n";
    formatmodifiers::ModifierHelp mh(os, 14);    
    mh(su::subformat::key::strict) <<
              "Abort if scalco violates the definition of SeismicUn*x.\n";
      mh() << "The default is to tolerate spatial sampling\n";
      mh() << "scaling factors being zero or being small\n";
      mh() << "powers of ten.\n";
  } // void isustream::help(std::ostream& os)

Here is the call graph for this function:

Here is the caller graph for this function: