X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scroll.3x.html;h=f6fbcbb0762684d1057895cb7e8c91b40307785f;hp=a3361cdea0466d9c62da92cfdf8e2270c1729e9b;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html index a3361cde..f6fbcbb0 100644 --- a/doc/html/man/curs_scroll.3x.html +++ b/doc/html/man/curs_scroll.3x.html @@ -1,6 +1,7 @@ -
- --curs_scroll(3x) curs_scroll(3x) +curs_scroll(3X) curs_scroll(3X)
- scroll, scrl, wscrl - scroll a curses window + scroll, scrl, wscrl - scroll a curses window
- #include <curses.h> + #include <curses.h> - int scroll(WINDOW *win); - int scrl(int n); - int wscrl(WINDOW *win, int n); + int scroll(WINDOW *win); + + int scrl(int n); + int wscrl(WINDOW *win, int n);
- The scroll routine scrolls the window up one line. This involves mov- + The scroll routine scrolls the window up one line. This involves mov- ing the lines in the window data structure. As an optimization, if the - scrolling region of the window is the entire screen, the physical - screen may be scrolled at the same time. + scrolling region of the window is the entire screen, the physical + screen may be scrolled at the same time. - For positive n, the scrl and wscrl routines scroll the window up n - lines (line i+n becomes i); otherwise scroll the window down n lines. + For positive n, the scrl and wscrl routines scroll the window up n + lines (line i+n becomes i); otherwise scroll the window down n lines. This involves moving the lines in the window character image structure. The current cursor position is not changed. - For these functions to work, scrolling must be enabled via scrollok. + For these functions to work, scrolling must be enabled via scrollok.
- These routines return ERR upon failure, and OK (SVr4 only specifies "an - integer value other than ERR") upon successful completion. + These routines return ERR upon failure, and OK (SVr4 only specifies "an + integer value other than ERR") upon successful completion. X/Open defines no error conditions. This implementation returns an error if the window pointer is null, or - if scrolling is not enabled in the window, e.g., with scrollok. + if scrolling is not enabled in the window, e.g., with scrollok.
- Note that scrl and scroll may be macros. + Note that scrl and scroll may be macros. The SVr4 documentation says that the optimization of physically scrolling immediately if the scroll region is the entire screen "is" @@ -100,11 +102,11 @@
- curses(3x), curs_outopts(3x) + curses(3X), curs_outopts(3X) - curs_scroll(3x) + curs_scroll(3X)