X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_kernel.3x.html;h=11f41d3162c1ce864144e25a3b86adf7a52e70be;hp=6ee8d58338ff980a0063089a7c9f85d217a6d263;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_kernel.3x.html b/doc/html/man/curs_kernel.3x.html index 6ee8d583..11f41d31 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
 
 
 
@@ -77,10 +77,10 @@ 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,21 +128,36 @@ 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 + The curs_set routine sets the cursor state is set to in- + visible, 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. + visibility requested, the previous cursor state is re- + turned; 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

@@ -174,12 +189,12 @@
 
 

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_kernel(3x)
+                                                        curs_kernel(3x)