doc/curses.n

   1 '\"
   2 '\" Copyright (c) 1996-1999 Christian Werner
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .so man.macros
   8 .TH curses n 8.0 Ck "Ck Built-In Commands"
   9 .BS
  10 '\" Note:  do not modify the .SH NAME line immediately below!
  11 .SH NAME
  12 curses \- Retrieve/modify curses based information
  13 .SH SYNOPSIS
  14 \fBcurses\fR \fIoption \fR?\fIarg arg ...\fR?
  15 .BE
  16
  17 .SH DESCRIPTION
  18 .PP
  19 The \fBcurses\fR command is used to retrieve or modify information
  20 which is related to the \fBcurses(3)\fR library providing the
  21 input/output mechanisms used by Ck.
  22 It can take any of a number of different forms,
  23 depending on the \fIoption\fR argument.  The legal forms are:
  24 .TP
  25 \fBcurses barcode\fR \fIstartChar endChar ?timeout?\fR
  26 Enables or modifies barcode reader support with delivery of \fBBarCode\fR
  27 events. \fIStartChar\fR and \fIendChar\fR are the start and end characters
  28 which delimit the barcode data packet without being delivered to the
  29 application. They must be specified as decimal numbers.
  30 The optional \fItimeout\fR argument is the maximum time between reception
  31 of start and end characters in millisecond for receiving the data packet;
  32 the default value is 1000.
  33 .TP
  34 \fBcurses barcode\fR \fI?off?\fR
  35 If \fIoff\fR is present, barcode reader support is disabled. Otherwise,
  36 the current start/end characters and the timeout are returned as a list
  37 of three decimal numbers.
  38 .TP
  39 \fBcurses baudrate\fR
  40 Returns the baud rate of the terminal as decimal string.
  41 .TP
  42 \fBcurses encoding \fR\fI?ISO8859|IBM437?\fR
  43 Sets or returns the character encoding being or to be used for
  44 displaying text. This affects for example the output of
  45 the text widget for the character values 0x80..0x9f.
  46 .TP
  47 \fBcurses gchar \fR\fI?charName? ?value?\fR
  48 Sets or returns the mappings of ``Alternate Character Set'' characters
  49 used to display the arrows of scrollbars, the indicators for checkbuttons
  50 and radiobuttons etc. \fICharName\fR must be a valid name of an ACS
  51 character (see list below), and \fIvalue\fR must be an integer, i.e.
  52 the value of the \fBcurses(3)\fR character which shall be output for the
  53 ACS character. By default the \fBterminfo(5)\fR entry for the terminal
  54 provides these mappings and there's rarely a need to modify them.
  55 .sp 1
  56 .ta 3c
  57 .nf
  58 \fBCk name      description\fR
  59 ulcorner        upper left corner
  60 urcorner        upper right corner
  61 llcorner        lower left corner
  62 lrcorner        lower right corner
  63 rtee    tee pointing right
  64 ltee    tee pointing left
  65 btee    tee pointing up
  66 ttee    tee pointing down
  67 hline   horizontal line
  68 vline   vertical line
  69 plus    large plus or crossover
  70 s1      scan line #1
  71 s9      scan line #9
  72 diamond diamond
  73 ckboard checker board (stipple)
  74 degree  degree symbol
  75 plminus plus/minus
  76 bullet  bullet
  77 larrow  arrow pointing left
  78 rarrow  arrow pointing right
  79 uarrow  arrow pointing up
  80 darrow  arrow pointing down
  81 board   board of squares
  82 lantern lantern symbol
  83 block   solid square block
  84 .fi
  85 .TP
  86 \fBcurses haskey\fR \fI?keyName?\fR
  87 If \fIkeyName\fR is omitted this command returns a list of all valid
  88 symbolic names of keyboard keys.
  89 If \fIkeyName\fR is given, a boolean is returned indicating if the
  90 terminal can generate that key.
  91 .TP
  92 \fBcurses purgeinput\fR
  93 Removes all characters typed so far from the keyboard input queue. This
  94 command should be used with great caution, since \fBxterm(1)\fR
  95 mouse events and barcode events are reported through the keyboard
  96 input queue as a character stream which can be interrupted
  97 by this command.
  98 .TP
  99 \fBcurses refreshdelay \fR\fI?milliseconds?\fR
 100 Sets or returns a time value which is used to limit the number of
 101 \fBcurses(3)\fR screen updates. By default the delay is zero, which
 102 does not impose any limits. Setting the refresh delay to a positive
 103 number can be useful in environments where the terminal is connected
 104 via terminal servers or \fBrlogin(1)\fR sessions.
 105 .TP
 106 \fBcurses reversekludge \fR\fI?boolean?\fR
 107 Queries or modifies special code for treatment of the reverse video
 108 attribute in conjunction with colors. On some terminals (e.g. the
 109 infamous AT386 Interactive console), the reverse attribute overrides
 110 the colors in effect. If the special code is enabled, the reverse
 111 attribute is emulated by swapping the foreground and background colors.
 112 .TP
 113 \fBcurses screendump \fR\fIfileName\fR
 114 Dumps the current screen contents to the file \fIfileName\fR if the
 115 curses library supports the \fBscr_dmp(3)\fR function. Otherwise an
 116 error is reported. The screen dump file is per se not useful, since
 117 it contains some binary representation internal to curses. However,
 118 there may exist an external utility program which transforms the screen
 119 dump file to ASCII in order to print it on paper.
 120 .TP
 121 \fBcurses suspend\fR
 122 Takes appropriate actions for job control, such as saving \fBcurses(3)\fR
 123 terminal state, sending the stop signal to the process and restoring
 124 the terminal state when the process is continued.
 125
 126 .SH "SEE ALSO"
 127 curses(3)
 128
 129 .SH KEYWORDS
 130 screen, terminal, curses
 131