senf/Utils/Termlib/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 //
  24 // Contributor(s):
  25 //   Stefan Bund <g0dil@berlios.de>
  26
  27
  28 /** \mainpage Terminal utility functions
  29
  30     The Termlib module provides several facilities to help working with terminal I/O
  31
  32     \autotoc
  33
  34     \section termlib_sect_telnet Telnet protocol implementation
  35     \seechapter \ref telnet_group
  36
  37     This is a partial implementation of the telnet protokoll. It provides enough functionality to
  38     provide terminal access.
  39
  40     \section termlib_sect_terminfo Terminfo database access
  41     \seechapter \ref terminfo_group
  42
  43     The senf::term::Terminfo class provides access to the termios database.
  44
  45     \section termlib_sect_editor Simple line-oriented text editor
  46     \seechapter senf::term::LineEditor
  47
  48     Using the termios functionality, this class implements simple line editing
  49
  50  */
  51
  52 \f
  53 // Local Variables:
  54 // mode: c++
  55 // fill-column: 100
  56 // comment-column: 40
  57 // c-file-style: "senf"
  58 // indent-tabs-mode: nil
  59 // ispell-local-dictionary: "american"
  60 // compile-command: "scons -u test"
  61 // mode: flyspell
  62 // mode: auto-fill
  63 // End: