home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / gnu / info / termcap.info-1 (.txt) < prev    next >
GNU Info File  |  1994-02-24  |  48KB  |  853 lines
  1. This is Info file /home/gd/gnu/termcap/termcap.info, produced by
  2. Makeinfo-1.52 from the input file /home/gd/gnu/termcap/termcap.texi.
  3.    This file documents the termcap library of the GNU system.
  4.    Copyright (C) 1988 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided that
  10. the entire resulting derived work is distributed under the terms of a
  11. permission notice identical to this one.
  12.    Permission is granted to copy and distribute translations of this
  13. manual into another language, under the above conditions for modified
  14. versions, except that this permission notice may be stated in a
  15. translation approved by the Foundation.
  16. File: termcap.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)
  17. * Menu:
  18. * Introduction::  What is termcap?  Why this manual?
  19. * Library::     The termcap library functions.
  20. * Data Base::   What terminal descriptions in `/etc/termcap' look like.
  21. * Capabilities::  Definitions of the individual terminal capabilities:
  22.                  how to write them in descriptions, and how to use
  23.                  their values to do display updating.
  24. * Summary::     Brief table of capability names and their meanings.
  25. * Var Index::   Index of C functions and variables.
  26. * Cap Index::   Index of termcap capabilities.
  27. * Index::       Concept index.
  28.  -- The Detailed Node Listing --
  29. The Termcap Library
  30. * Preparation::  Preparing to use the termcap library.
  31. * Find::        Finding the description of the terminal being used.
  32. * Interrogate::  Interrogating the description for particular capabilities.
  33. * Initialize::  Initialization for output using termcap.
  34. * Padding::     Outputting padding.
  35. * Parameters::  Encoding parameters such as cursor positions.
  36. Padding
  37. * Why Pad::     Explanation of padding.
  38. * Not Enough::  When there is not enough padding.
  39. * Describe Padding::  The data base says how much padding a terminal needs.
  40. * Output Padding::    Using `tputs' to output the needed padding.
  41. Filling In Parameters
  42. * Encode Parameters::  The language for encoding parameters.
  43. * Using Parameters::   Outputting a string command with parameters.
  44. Sending Display Commands with Parameters
  45. * tparam::      The general case, for GNU termcap only.
  46. * tgoto::       The special case of cursor motion.
  47. The Format of the Data Base
  48. * Format::      Overall format of a terminal description.
  49. * Capability Format::  Format of capabilities within a description.
  50. * Naming::      Naming conventions for terminal types.
  51. * Inheriting::  Inheriting part of a description from
  52. a related terminal type.
  53. * Changing::    When changes in the data base take effect.
  54. Definitions of the Terminal Capabilities
  55. * Basic::       Basic characteristics.
  56. * Screen Size::  Screen size, and what happens when it changes.
  57. * Cursor Motion::  Various ways to move the cursor.
  58. * Wrapping::    What happens if you write a character in the last column.
  59. * Scrolling::   Pushing text up and down on the screen.
  60. * Windows::     Limiting the part of the window that output affects.
  61. * Clearing::    Erasing one or many lines.
  62. * Insdel Line::  Making new blank lines in mid-screen; deleting lines.
  63. * Insdel Char::  Inserting and deleting characters within a line.
  64. * Standout::    Highlighting some of the text.
  65. * Underlining::  Underlining some of the text.
  66. * Cursor Visibility::  Making the cursor more or less easy to spot.
  67. * Bell::        Attracts user's attention; not localized on the screen.
  68. * Keypad::      Recognizing when function keys or arrows are typed.
  69. * Meta Key::    META acts like an extra shift key.
  70. * Initialization::  Commands used to initialize or reset the terminal.
  71. * Pad Specs::   Info for the kernel on how much padding is needed.
  72. * Status Line::  A status line displays "background" information.
  73. * Half-Line::   Moving by half-lines, for superscripts and subscripts.
  74. * Printer::     Controlling auxiliary printers of display terminals.
  75. File: termcap.info,  Node: Introduction,  Next: Library,  Prev: Top,  Up: Top
  76. Introduction
  77. ************
  78.    "Termcap" is a library and data base that enables programs to use
  79. display terminals in a terminal-independent manner.  It originated in
  80. Berkeley Unix.
  81.    The termcap data base describes the capabilities of hundreds of
  82. different display terminals in great detail.  Some examples of the
  83. information recorded for a terminal could include how many columns wide
  84. it is, what string to send to move the cursor to an arbitrary position
  85. (including how to encode the row and column numbers), how to scroll the
  86. screen up one or several lines, and how much padding is needed for such
  87. a scrolling operation.
  88.    The termcap library is provided for easy access this data base in
  89. programs that want to do terminal-independent character-based display
  90. output.
  91.    This manual describes the GNU version of the termcap library, which
  92. has some extensions over the Unix version.  All the extensions are
  93. identified as such, so this manual also tells you how to use the Unix
  94. termcap.
  95.    The GNU version of the termcap library is available free as source
  96. code, for use in free programs, and runs on Unix and VMS systems (at
  97. least).  You can find it in the GNU Emacs distribution in the files
  98. `termcap.c' and `tparam.c'.
  99.    This manual was written for the GNU project, whose goal is to
  100. develop a complete free operating system upward-compatible with Unix
  101. for user programs.  The project is approximately two thirds complete.
  102. For more information on the GNU project, including the GNU Emacs editor
  103. and the mostly-portable optimizing C compiler, send one dollar to
  104.      Free Software Foundation
  105.      675 Mass Ave
  106.      Cambridge, MA 02139
  107. File: termcap.info,  Node: Library,  Next: Data Base,  Prev: Introduction,  Up: Top
  108. The Termcap Library
  109. *******************
  110.    The termcap library is the application programmer's interface to the
  111. termcap data base.  It contains functions for the following purposes:
  112.    * Finding the description of the user's terminal type (`tgetent').
  113.    * Interrogating the description for information on various topics
  114.      (`tgetnum', `tgetflag', `tgetstr').
  115.    * Computing and performing padding (`tputs').
  116.    * Encoding numeric parameters such as cursor positions into the
  117.      terminal-specific form required for display commands (`tparam',
  118.      `tgoto').
  119. * Menu:
  120. * Preparation::  Preparing to use the termcap library.
  121. * Find::        Finding the description of the terminal being used.
  122. * Interrogate::  Interrogating the description for particular capabilities.
  123. * Initialize::  Initialization for output using termcap.
  124. * Padding::     Outputting padding.
  125. * Parameters::  Encoding parameters such as cursor positions.
  126. File: termcap.info,  Node: Preparation,  Next: Find,  Up: Library
  127. Preparing to Use the Termcap Library
  128. ====================================
  129.    To use the termcap library in a program, you need two kinds of
  130. preparation:
  131.    * The compiler needs declarations of the functions and variables in
  132.      the library.
  133.      On GNU systems, it suffices to include the header file `termcap.h'
  134.      in each source file that uses these functions and variables.
  135.      On Unix systems, there is often no such header file.  Then you must
  136.      explictly declare the variables as external.  You can do likewise
  137.      for the functions, or let them be implicitly declared and cast
  138.      their values from type `int' to the appropriate type.
  139.      We illustrate the declarations of the individual termcap library
  140.      functions with ANSI C prototypes because they show how to pass the
  141.      arguments.  If you are not using the GNU C compiler, you probably
  142.      cannot use function prototypes, so omit the argument types and
  143.      names from your declarations.
  144.    * The linker needs to search the library.  Usually either
  145.      `-ltermcap' or `-ltermlib' as an argument when linking will do
  146.      this.
  147. File: termcap.info,  Node: Find,  Next: Interrogate,  Prev: Preparation,  Up: Library
  148. Finding a Terminal Description: `tgetent'
  149. =========================================
  150.    An