basis/io/crlf/crlf-docs.factor

   1 ! Copyright (C) 2009 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.syntax help.markup sequences ;
   4 IN: io.crlf
   5
   6 HELP: crlf
   7 { $values }
   8 { $description "Prints a carriage return and line feed to the current output stream, used to indicate a newline for certain network protocols." } ;
   9
  10 HELP: read-crlf
  11 { $values { "seq" sequence } }
  12 { $description "Reads until the next CRLF (carriage return followed by line feed) from the current input stream, throwing an error if there is not a CRLF remaining, or if CR is present without immediately being followed by LF." } ;