sdk/lib/conutils/README.txt

   1 The ReactOS Console Utilities Library v0.1
   2 ==========================================
   3
   4 COPYRIGHT:  Under GPLv2, see COPYING in the top level directory.
   5 CREDITS:    Thanks to the many people who originally wrote the code that finally
   6             ended up inside this library, with more or less refactoring, or
   7             whose code served as a basis for some functions of the library.
   8
   9
  10 INTRODUCTION
  11 ~-~-~-~-~-~-
  12
  13 This library contains common functions used in many places inside the ReactOS
  14 console utilities and the ReactOS Command-Line Interpreter. Most of these
  15 functions are related with internationalisation and the problem of correctly
  16 displaying Unicode text on the console. Besides those, helpful functions for
  17 retrieving strings and messages from application resources are provided,
  18 together with printf-like functionality.
  19
  20
  21 CONTENTS
  22 ~-~-~-~-
  23
  24 0. 'conutils_base' (utils.c and utils.h): Base set of functions for loading
  25    string resources and message strings, and handle type identification.
  26
  27 1. 'conutils_stream' (stream.c and stream.h): Console Stream API (CON_STREAM):
  28    Stream initialization, basic ConStreamRead/Write. Stream utility functions:
  29    ConPuts/Printf, ConResPuts/Printf, ConMsgPuts/Printf.
  30    Depends on 'conutils_base'.
  31
  32 2. 'conutils_screen' (screen.c and screen.h): Console Screen API (CON_SCREEN):
  33    Introduces the notion of console/terminal screen around the streams. Manages
  34    console/terminal screen metrics for Win32 consoles and TTYs (serial...).
  35    Additional Screen utility functions.
  36    Depends on 'conutils_stream', and indirectly on 'conutils_base'.
  37
  38 3. 'conutils_pager' (pager.c and pager.h): Console Pager API (CON_PAGER):
  39    Implements core console/terminal paging functionality around console screens.
  40    Depends on 'conutils_screen'  and indirectly on 'conutils_stream' and
  41    'conutils_base'.
  42
  43 4. More to come!