senf/Utils/Termlib/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \mainpage Terminal utility functions
  24
  25     The Termlib module provides several facilities to help working with terminal I/O
  26
  27     \autotoc
  28
  29     \section termlib_sect_telnet Telnet protocol implementation
  30     \seechapter \ref telnet_group
  31
  32     This is a partial implementation of the telnet protokoll. It provides enough functionality to
  33     provide terminal access.
  34
  35     \section termlib_sect_terminfo Terminfo database access
  36     \seechapter \ref terminfo_group
  37
  38     The senf::term::Terminfo class provides access to the termios database.
  39
  40     \section termlib_sect_editor Simple line-oriented text editor
  41     \seechapter senf::term::LineEditor
  42
  43     Using the termios functionality, this class implements simple line editing
  44
  45  */
  46
  47 \f
  48 // Local Variables:
  49 // mode: c++
  50 // fill-column: 100
  51 // comment-column: 40
  52 // c-file-style: "senf"
  53 // indent-tabs-mode: nil
  54 // ispell-local-dictionary: "american"
  55 // compile-command: "scons -u test"
  56 // mode: flyspell
  57 // mode: auto-fill
  58 // End: