X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_kernel.3x.html;h=a2e247cea512ff7c6fcfb6fdfd7561ca8450bffc;hb=refs%2Ftags%2Fv5.9;hp=6ee8d58338ff980a0063089a7c9f85d217a6d263;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/doc/html/man/curs_kernel.3x.html b/doc/html/man/curs_kernel.3x.html index 6ee8d583..a2e247ce 100644 --- a/doc/html/man/curs_kernel.3x.html +++ b/doc/html/man/curs_kernel.3x.html @@ -1,7 +1,7 @@ @@ -40,16 +40,16 @@
 
-curs_kernel(3x)                                   curs_kernel(3x)
+curs_kernel(3x)                                         curs_kernel(3x)
 
 
 
 
 

NAME

-       def_prog_mode,       def_shell_mode,      reset_prog_mode,
-       reset_shell_mode, resetty, savetty, getsyx, setsyx, ripof-
-       fline, curs_set, napms - low-level curses routines
+       def_prog_mode, def_shell_mode, reset_prog_mode,
+       reset_shell_mode, resetty, savetty, getsyx, setsyx,
+       ripoffline, curs_set, napms - low-level curses routines
 
 
 
@@ -72,15 +72,15 @@

DESCRIPTION

        The  following  routines  give low-level access to various
-       curses capabilities.  Theses routines typically  are  used
+       curses capabilities.  These routines  typically  are  used
        inside library routines.
 
        The  def_prog_mode  and  def_shell_mode  routines save the
        current terminal modes as the  "program"  (in  curses)  or
-       "shell"   (not   in   curses)   state   for   use  by  the
-       reset_prog_mode and reset_shell_mode  routines.   This  is
-       done  automatically  by  initscr.   There is one such save
-       area for each screen context allocated by newterm().
+       "shell"   (not  in  curses)  state  for  use  by  the  re-
+       set_prog_mode and reset_shell_mode routines.  This is done
+       automatically by initscr.  There is one such save area for
+       each screen context allocated by newterm().
 
        The reset_prog_mode and reset_shell_mode routines  restore
        the  terminal  to "program" (in curses) or "shell" (out of
@@ -96,22 +96,22 @@
        The  getsyx routine returns the current coordinates of the
        virtual screen cursor in y and x.  If leaveok is currently
        TRUE,  then -1,-1 is returned.  If lines have been removed
-       from the top of the screen,  using  ripoffline,  y  and  x
-       include  these  lines;  therefore,  y and x should be used
-       only as arguments for setsyx.
+       from the top of the screen, using ripoffline, y and x  in-
+       clude  these lines; therefore, y and x should be used only
+       as arguments for setsyx.
 
        The setsyx routine sets the virtual screen cursor to y, x.
        If y and x are both -1, then leaveok is set.  The two rou-
-       tines getsyx and setsyx are  designed  to  be  used  by  a
-       library routine, which manipulates curses windows but does
+       tines getsyx and setsyx are designed to be used by  a  li-
+       brary  routine,  which manipulates curses windows but does
        not want to change the current position of  the  program's
-       cursor.   The  library  routine  would  call getsyx at the
-       beginning, do its manipulation of its own  windows,  do  a
+       cursor.   The library routine would call getsyx at the be-
+       ginning, do its manipulation of  its  own  windows,  do  a
        wnoutrefresh  on  its  windows, call setsyx, and then call
        doupdate.
 
-       The ripoffline routine provides access to the same  facil-
-       ity  that  slk_init  [see curs_slk(3x)] uses to reduce the
+       The ripoffline routine provides access to the same facili-
+       ty  that  slk_init  [see  curs_slk(3x)] uses to reduce the
        size of the screen.   ripoffline  must  be  called  before
        initscr or newterm is called.  If line is positive, a line
        is removed from the top of stdscr; if line is negative,  a
@@ -128,58 +128,74 @@
        ripoffline  can  be called up to five times before calling
        initscr or newterm.
 
-       The curs_set routine sets  the  cursor  state  is  set  to
-       invisible, normal, or very visible for visibility equal to
-       0, 1, or 2 respectively.  If  the  terminal  supports  the
-       visibility   requested,   the  previous  cursor  state  is
-       returned; otherwise, ERR is returned.
+       The curs_set routine sets the cursor state  to  invisible,
+       normal, or very visible for visibility equal to 0, 1, or 2
+       respectively.  If the terminal supports the visibility re-
+       quested, the previous cursor state is returned; otherwise,
+       ERR is returned.
 
        The napms routine is used to sleep for ms milliseconds.
 
 
 

RETURN VALUE

-       Except for curs_set,  these  routines  always  return  OK.
-       curs_set  returns the previous cursor state, or ERR if the
+       Except for curs_set, these routines always return OK.
+
+       curs_set returns the previous cursor state, or ERR if  the
        requested visibility is not supported.
 
+       X/Open  defines  no error conditions.  In this implementa-
+       tion
+
+              def_prog_mode, def_shell_mode, reset_prog_mode, re-
+              set_shell_mode
+                   return  an  error if the terminal was not ini-
+                   tialized, or if the I/O  call  to  obtain  the
+                   terminal settings fails.
+
+              ripoffline
+                   returns  an  error  if  the  maximum number of
+                   ripped-off lines exceeds the maximum (NRIPS  =
+                   5).
+
 
 

NOTES

-       Note that getsyx is a macro, so & is not necessary  before
+       Note  that getsyx is a macro, so & is not necessary before
        the variables y and x.
 
-       Older  SVr4  man  pages  warn  that  the  return  value of
-       curs_set "is currently  incorrect".   This  implementation
-       gets  it  right, but it may be unwise to count on the cor-
+       Older SVr4  man  pages  warn  that  the  return  value  of
+       curs_set  "is  currently  incorrect".  This implementation
+       gets it right, but it may be unwise to count on  the  cor-
        rectness of the return value anywhere else.
 
-       Both ncurses and SVr4 will  call  curs_set  in  endwin  if
-       curs_set  has  been  called  to make the cursor other than
-       normal, i.e., either invisible or very visible.  There  is
-       no  way  for ncurses to determine the initial cursor state
+       Both  ncurses  and  SVr4  will  call curs_set in endwin if
+       curs_set has been called to make  the  cursor  other  than
+       normal,  i.e., either invisible or very visible.  There is
+       no way for ncurses to determine the initial  cursor  state
        to restore that.
 
 
 

PORTABILITY

-       The functions setsyx and getsyx are not described  in  the
-       XSI  Curses standard, Issue 4.  All other functions are as
+       The  functions  setsyx and getsyx are not described in the
+       XSI Curses standard, Issue 4.  All other functions are  as
        described in XSI Curses.
 
        The SVr4 documentation describes setsyx and getsyx as hav-
-       ing  return  type  int.  This  is  misleading, as they are
-       macros with no documented semantics for the return  value.
+       ing return type int.  This  is  misleading,  as  they  are
+       macros with no documented semantics for the return value.
 
 
 

SEE ALSO

-       curses(3x),       curs_initscr(3x),      curs_outopts(3x),
-       curs_refresh(3x), curs_scr_dump(3x), curs_slk(3x)
+       curses(3x),  curs_initscr(3x),  curs_outopts(3x), curs_re-
+       fresh(3x),  curs_scr_dump(3x),  curs_slk(3x),   curs_vari-
+       ables(3x).
 
 
 
-                                                  curs_kernel(3x)
+                                                        curs_kernel(3x)