X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_scroll.3x;h=d9e45f2d5becbfb8bde4eeb83f8278b86d34afa7;hp=754b71499841e5a2fdc93ede8fd42e9f6275182b;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x index 754b7149..d9e45f2d 100644 --- a/man/curs_scroll.3x +++ b/man/curs_scroll.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,32 +27,36 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scroll.3x,v 1.13 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_scroll.3x,v 1.19 2020/10/24 09:45:48 tom Exp $ .TH curs_scroll 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .na .hy 0 .SH NAME \fBscroll\fR, \fBscrl\fR, -\fBwscrl\fR - scroll a \fBcurses\fR window +\fBwscrl\fR \- scroll a \fBcurses\fR window .ad .hy .SH SYNOPSIS \fB#include \fR .sp -\fBint scroll(WINDOW *win);\fR -.br -\fBint scrl(int n);\fR +\fBint scroll(WINDOW *\fP\fIwin\fP\fB);\fR +.sp +\fBint scrl(int \fP\fIn\fP\fB);\fR .br -\fBint wscrl(WINDOW *win, int n);\fR +\fBint wscrl(WINDOW *\fP\fIwin\fP\fB, int \fP\fIn\fP\fB);\fR .br .SH DESCRIPTION The \fBscroll\fR routine scrolls the window up one line. This involves moving 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. +region of the window is the entire screen, +the \fIphysical screen\fP may be scrolled at the same time. .PP For positive \fIn\fR, the \fBscrl\fR and \fBwscrl\fR routines scroll the window up \fIn\fR lines (line \fIi\fR+\fIn\fR becomes \fIi\fR); otherwise @@ -74,8 +79,8 @@ if scrolling is not enabled in the window, e.g., with \fBscrollok\fP. Note that \fBscrl\fR and \fBscroll\fR may be macros. .PP The SVr4 documentation says that the optimization of physically scrolling -immediately if the scroll region is the entire screen "is" performed, not -"may be" performed. +immediately if the scroll region is the entire screen \*(``is\*('' performed, not +\*(``may be\*('' performed. This implementation deliberately does not guarantee that this will occur, to leave open the possibility of smarter optimization of multiple scroll actions on the next update. @@ -88,9 +93,3 @@ Under this implementation it is. The XSI Curses standard, Issue 4 describes these functions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: