Changeset 391 for python/trunk/Doc/library/curses.rst

Timestamp:

Mar 19, 2014, 11:31:01 PM (11 years ago)

Author:

dmik

Message:

python: Merge vendor 2.7.6 to trunk.

Location:

python/trunk

Files:

• . (modified) (1 prop)
• Doc/library/curses.rst (modified) (85 diffs)

python/trunk/Doc/library/curses.rst

@@ -45 +45 @@
       Editable text widget for curses supporting  :program:`Emacs`\ -like bindings.
 
-   Module :mod:`curses.wrapper`
-      Convenience function to ensure proper terminal setup and resetting on
-      application entry and exit.
-
    :ref:`curses-howto`
       Tutorial material on using curses with Python, by Andrew Kuchling and Eric
       Raymond.
 
-   The :file:`Demo/curses/` directory in the Python source distribution contains
+   The :source:`Demo/curses/` directory in the Python source distribution contains
    some example programs using the curses bindings provided by this module.
 
@@ -80 +76 @@
 .. function:: baudrate()
 
-   Returns the output speed of the terminal in bits per second.  On software
+   Return the output speed of the terminal in bits per second.  On software
    terminal emulators it will have a fixed high value. Included for historical
    reasons; in former times, it was used to  write output loops for time delays and
@@ -93 +89 @@
 .. function:: can_change_color()
 
-   Returns true or false, depending on whether the programmer can change the colors
+   Return ``True`` or ``False``, depending on whether the programmer can change the colors
    displayed by the terminal.
 
@@ -108 +104 @@
 .. function:: color_content(color_number)
 
-   Returns the intensity of the red, green, and blue (RGB) components in the color
+   Return the intensity of the red, green, and blue (RGB) components in the color
    *color_number*, which must be between ``0`` and :const:`COLORS`.  A 3-tuple is
    returned, containing the R,G,B values for the given color, which will be between
@@ -116 +112 @@
 .. function:: color_pair(color_number)
 
-   Returns the attribute value for displaying text in the specified color.  This
+   Return the attribute value for displaying text in the specified color.  This
    attribute value can be combined with :const:`A_STANDOUT`, :const:`A_REVERSE`,
    and the other :const:`A_\*` attributes.  :func:`pair_number` is the counterpart
@@ -124 +120 @@
 .. function:: curs_set(visibility)
 
-   Sets the cursor state.  *visibility* can be set to 0, 1, or 2, for invisible,
+   Set the cursor state.  *visibility* can be set to 0, 1, or 2, for invisible,
    normal, or very visible.  If the terminal supports the visibility requested, the
    previous cursor state is returned; otherwise, an exception is raised.  On many
@@ -133 +129 @@
 .. function:: def_prog_mode()
 
-   Saves the current terminal mode as the "program" mode, the mode when the running
+   Save the current terminal mode as the "program" mode, the mode when the running
    program is using curses.  (Its counterpart is the "shell" mode, for when the
    program is not in curses.)  Subsequent calls to :func:`reset_prog_mode` will
@@ -141 +137 @@
 .. function:: def_shell_mode()
 
-   Saves the current terminal mode as the "shell" mode, the mode when the running
+   Save the current terminal mode as the "shell" mode, the mode when the running
    program is not using curses.  (Its counterpart is the "program" mode, when the
    program is using curses capabilities.) Subsequent calls to
@@ -149 +145 @@
 .. function:: delay_output(ms)
 
-   Inserts an *ms* millisecond pause in output.
+   Insert an *ms* millisecond pause in output.
 
 
@@ -180 +176 @@
 .. function:: erasechar()
 
-   Returns the user's current erase character.  Under Unix operating systems this
+   Return the user's current erase character.  Under Unix operating systems this
    is a property of the controlling tty of the curses program, and is not set by
    the curses library itself.
@@ -188 +184 @@
 
    The :func:`.filter` routine, if used, must be called before :func:`initscr` is
-   called.  The effect is that, during those calls, LINES is set to 1; the
+   called.  The effect is that, during those calls, :envvar:`LINES` is set to 1; the
    capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home
    string is set to the value of cr. The effect is that the cursor is confined to
@@ -214 +210 @@
    5-tuple ``(id, x, y, z, bstate)``. *id* is an ID value used to distinguish
    multiple devices, and *x*, *y*, *z* are the event's coordinates.  (*z* is
-   currently unused.).  *bstate* is an integer value whose bits will be set to
+   currently unused.)  *bstate* is an integer value whose bits will be set to
    indicate the type of event, and will be the bitwise OR of one or more of the
    following constants, where *n* is the button number from 1 to 4:
@@ -224 +220 @@
 .. function:: getsyx()
 
-   Returns the current coordinates of the virtual screen cursor in y and x.  If
+   Return the current coordinates of the virtual screen cursor in y and x.  If
    leaveok is currently true, then -1,-1 is returned.
 
@@ -230 +226 @@
 .. function:: getwin(file)
 
-   Reads window related data stored in the file by an earlier :func:`putwin` call.
+   Read window related data stored in the file by an earlier :func:`putwin` call.
    The routine then creates and initializes a new window using that data, returning
    the new window object.
@@ -237 +233 @@
 .. function:: has_colors()
 
-   Returns true if the terminal can display colors; otherwise, it returns false.
+   Return ``True`` if the terminal can display colors; otherwise, return ``False``.
 
 
 .. function:: has_ic()
 
-   Returns true if the terminal has insert- and delete- character capabilities.
+   Return ``True`` if the terminal has insert- and delete-character capabilities.
    This function is included for historical reasons only, as all modern software
    terminal emulators have such capabilities.
@@ -249 +245 @@
 .. function:: has_il()
 
-   Returns true if the terminal has insert- and delete-line  capabilities,  or  can
+   Return ``True`` if the terminal has insert- and delete-line capabilities, or can
    simulate  them  using scrolling regions. This function is included for
    historical reasons only, as all modern software terminal emulators have such
@@ -257 +253 @@
 .. function:: has_key(ch)
 
-   Takes a key value *ch*, and returns true if the current terminal type recognizes
+   Take a key value *ch*, and return ``True`` if the current terminal type recognizes
    a key with that value.
 
@@ -266 +262 @@
    typed by the user are immediately available to the program. However, after
    blocking for *tenths* tenths of seconds, an exception is raised if nothing has
-   been typed.  The value of *tenths* must be a number between 1 and 255.  Use
+   been typed.  The value of *tenths* must be a number between ``1`` and ``255``.  Use
    :func:`nocbreak` to leave half-delay mode.
 
@@ -272 +268 @@
 .. function:: init_color(color_number, r, g, b)
 
-   Changes the definition of a color, taking the number of the color to be changed
+   Change the definition of a color, taking the number of the color to be changed
    followed by three RGB values (for the amounts of red, green, and blue
    components).  The value of *color_number* must be between ``0`` and
@@ -283 +279 @@
 .. function:: init_pair(pair_number, fg, bg)
 
-   Changes the definition of a color-pair.  It takes three arguments: the number of
+   Change the definition of a color-pair.  It takes three arguments: the number of
    the color-pair to be changed, the foreground color number, and the background
    color number.  The value of *pair_number* must be between ``1`` and
@@ -295 +291 @@
 .. function:: initscr()
 
-   Initialize the library. Returns a :class:`WindowObject` which represents the
+   Initialize the library. Return a :class:`WindowObject` which represents the
    whole screen.
 
@@ -304 +300 @@
 
 
+.. function:: is_term_resized(nlines, ncols)
+
+   Return ``True`` if :func:`resize_term` would modify the window structure,
+   ``False`` otherwise.
+
+
 .. function:: isendwin()
 
-   Returns true if :func:`endwin` has been called (that is, the  curses library has
+   Return ``True`` if :func:`endwin` has been called (that is, the  curses library has
    been deinitialized).
 
@@ -322 +324 @@
 .. function:: killchar()
 
-   Returns the user's current line kill character. Under Unix operating systems
+   Return the user's current line kill character. Under Unix operating systems
    this is a property of the controlling tty of the curses program, and is not set
    by the curses library itself.
@@ -329 +331 @@
 .. function:: longname()
 
-   Returns a string containing the terminfo long name field describing the current
+   Return a string containing the terminfo long name field describing the current
    terminal.  The maximum length of a verbose description is 128 characters.  It is
    defined only after the call to :func:`initscr`.
@@ -342 +344 @@
 .. function:: mouseinterval(interval)
 
-   Sets the maximum time in milliseconds that can elapse between press and release
-   events in order for them to be recognized as a click, and returns the previous
+   Set the maximum time in milliseconds that can elapse between press and release
+   events in order for them to be recognized as a click, and return the previous
    interval value.  The default value is 200 msec, or one fifth of a second.
 
@@ -349 +351 @@
 .. function:: mousemask(mousemask)
 
-   Sets the mouse events to be reported, and returns a tuple ``(availmask,
+   Set the mouse events to be reported, and return a tuple ``(availmask,
    oldmask)``.   *availmask* indicates which of the specified mouse events can be
    reported; on complete failure it returns 0.  *oldmask* is the previous value of
@@ -363 +365 @@
 .. function:: newpad(nlines, ncols)
 
-   Creates and returns a pointer to a new pad data structure with the given number
+   Create and return a pointer to a new pad data structure with the given number
    of lines and columns.  A pad is returned as a window object.
 
@@ -373 +375 @@
    methods of a pad require 6 arguments to specify the part of the pad to be
    displayed and the location on the screen to be used for the display. The
-   arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p
+   arguments are *pminrow*, *pmincol*, *sminrow*, *smincol*, *smaxrow*, *smaxcol*; the *p*
    arguments refer to the upper left corner of the pad region to be displayed and
-   the s arguments define a clipping box on the screen within which the pad region
+   the *s* arguments define a clipping box on the screen within which the pad region
    is to be displayed.
 
 
-.. function:: newwin([nlines, ncols,] begin_y, begin_x)
+.. function:: newwin(begin_y, begin_x)
+              newwin(nlines, ncols, begin_y, begin_x)
 
    Return a new window, whose left-upper corner is at  ``(begin_y, begin_x)``, and
@@ -417 +420 @@
 .. function:: noqiflush()
 
-   When the noqiflush routine is used, normal flush of input and output queues
+   When the :func:`noqiflush` routine is used, normal flush of input and output queues
    associated with the INTR, QUIT and SUSP characters will not be done.  You may
    want to call :func:`noqiflush` in a signal handler if you want output to
@@ -430 +433 @@
 .. function:: pair_content(pair_number)
 
-   Returns a tuple ``(fg, bg)`` containing the colors for the requested color pair.
+   Return a tuple ``(fg, bg)`` containing the colors for the requested color pair.
    The value of *pair_number* must be between ``1`` and ``COLOR_PAIRS - 1``.
 
@@ -436 +439 @@
 .. function:: pair_number(attr)
 
-   Returns the number of the color-pair set by the attribute value *attr*.
+   Return the number of the color-pair set by the attribute value *attr*.
    :func:`color_pair` is the counterpart to this function.
 
@@ -442 +445 @@
 .. function:: putp(string)
 
-   Equivalent to ``tputs(str, 1, putchar)``; emits the value of a specified
-   terminfo capability for the current terminal.  Note that the output of putp
+   Equivalent to ``tputs(str, 1, putchar)``; emit the value of a specified
+   terminfo capability for the current terminal.  Note that the output of :func:`putp`
    always goes to standard output.
 
@@ -449 +452 @@
 .. function:: qiflush( [flag] )
 
-   If *flag* is false, the effect is the same as calling :func:`noqiflush`. If
-   *flag* is true, or no argument is provided, the queues will be flushed when
+   If *flag* is ``False``, the effect is the same as calling :func:`noqiflush`. If
+   *flag* is ``True``, or no argument is provided, the queues will be flushed when
    these control characters are read.
 
@@ -463 +466 @@
 .. function:: reset_prog_mode()
 
-   Restores the  terminal  to "program" mode, as previously saved  by
+   Restore the  terminal  to "program" mode, as previously saved  by
    :func:`def_prog_mode`.
 
@@ -469 +472 @@
 .. function:: reset_shell_mode()
 
-   Restores the  terminal  to "shell" mode, as previously saved  by
+   Restore the  terminal  to "shell" mode, as previously saved  by
    :func:`def_shell_mode`.
 
 
+.. function:: resetty()
+
+   Restore the state of the terminal modes to what it was at the last call to
+   :func:`savetty`.
+
+
+.. function:: resize_term(nlines, ncols)
+
+   Backend function used by :func:`resizeterm`, performing most of the work;
+   when resizing the windows, :func:`resize_term` blank-fills the areas that are
+   extended.  The calling application should fill in these areas with
+   appropriate data.  The :func:`resize_term` function attempts to resize all
+   windows.  However, due to the calling convention of pads, it is not possible
+   to resize these without additional interaction with the application.
+
+
+.. function:: resizeterm(nlines, ncols)
+
+   Resize the standard and current windows to the specified dimensions, and
+   adjusts other bookkeeping data used by the curses library that record the
+   window dimensions (in particular the SIGWINCH handler).
+
+
+.. function:: savetty()
+
+   Save the current state of the terminal modes in a buffer, usable by
+   :func:`resetty`.
+
+
 .. function:: setsyx(y, x)
 
-   Sets the virtual screen cursor to *y*, *x*. If *y* and *x* are both -1, then
+   Set the virtual screen cursor to *y*, *x*. If *y* and *x* are both -1, then
    leaveok is set.
 
@@ -481 +513 @@
 .. function:: setupterm([termstr, fd])
 
-   Initializes the terminal.  *termstr* is a string giving the terminal name; if
-   omitted, the value of the TERM environment variable will be used.  *fd* is the
+   Initialize the terminal.  *termstr* is a string giving the terminal name; if
+   omitted, the value of the :envvar:`TERM` environment variable will be used.  *fd* is the
    file descriptor to which any initialization sequences will be sent; if not
    supplied, the file descriptor for ``sys.stdout`` will be used.
@@ -502 +534 @@
 .. function:: termattrs()
 
-   Returns a logical OR of all video attributes supported by the terminal.  This
+   Return a logical OR of all video attributes supported by the terminal.  This
    information is useful when a curses program needs complete control over the
    appearance of the screen.
@@ -509 +541 @@
 .. function:: termname()
 
-   Returns the value of the environment variable TERM, truncated to 14 characters.
+   Return the value of the environment variable :envvar:`TERM`, truncated to 14 characters.
 
 
 .. function:: tigetflag(capname)
 
-   Returns the value of the Boolean capability corresponding to the terminfo
+   Return the value of the Boolean capability corresponding to the terminfo
    capability name *capname*.  The value ``-1`` is returned if *capname* is not a
    Boolean capability, or ``0`` if it is canceled or absent from the terminal
@@ -522 +554 @@
 .. function:: tigetnum(capname)
 
-   Returns the value of the numeric capability corresponding to the terminfo
+   Return the value of the numeric capability corresponding to the terminfo
    capability name *capname*.  The value ``-2`` is returned if *capname* is not a
    numeric capability, or ``-1`` if it is canceled or absent from the terminal
@@ -530 +562 @@
 .. function:: tigetstr(capname)
 
-   Returns the value of the string capability corresponding to the terminfo
+   Return the value of the string capability corresponding to the terminfo
    capability name *capname*.  ``None`` is returned if *capname* is not a string
    capability, or is canceled or absent from the terminal description.
@@ -537 +569 @@
 .. function:: tparm(str[,...])
 
-   Instantiates the string *str* with the supplied parameters, where  *str* should
-   be a parameterized string obtained from the terminfo  database.  E.g.
-   ``tparm(tigetstr("cup"), 5, 3)`` could result in  ``'\033[6;4H'``, the exact
+   Instantiate the string *str* with the supplied parameters, where *str* should
+   be a parameterized string obtained from the terminfo database.  E.g.
+   ``tparm(tigetstr("cup"), 5, 3)`` could result in ``'\033[6;4H'``, the exact
    result depending on terminal type.
 
@@ -545 +577 @@
 .. function:: typeahead(fd)
 
-   Specifies that the file descriptor *fd* be used for typeahead checking.  If *fd*
+   Specify that the file descriptor *fd* be used for typeahead checking.  If *fd*
    is ``-1``, then no typeahead checking is done.
 
@@ -557 +589 @@
 .. function:: unctrl(ch)
 
-   Returns a string which is a printable representation of the character *ch*.
+   Return a string which is a printable representation of the character *ch*.
    Control characters are displayed as a caret followed by the character, for
    example as ``^C``. Printing characters are left as they are.
@@ -580 +612 @@
 
    If used, this function should be called before :func:`initscr` or newterm are
-   called.  When *flag* is false, the values of lines and columns specified in the
+   called.  When *flag* is ``False``, the values of lines and columns specified in the
    terminfo database will be used, even if environment variables :envvar:`LINES`
    and :envvar:`COLUMNS` (used by default) are set, or if curses is running in a
@@ -596 +628 @@
 
 
+.. function:: wrapper(func, ...)
+
+   Initialize curses and call another callable object, *func*, which should be the
+   rest of your curses-using application.  If the application raises an exception,
+   this function will restore the terminal to a sane state before re-raising the
+   exception and generating a traceback.  The callable object *func* is then passed
+   the main window 'stdscr' as its first argument, followed by any other arguments
+   passed to :func:`wrapper`.  Before calling *func*, :func:`wrapper` turns on
+   cbreak mode, turns off echo, enables the terminal keypad, and initializes colors
+   if the terminal has color support.  On exit (whether normally or by exception)
+   it restores cooked mode, turns on echo, and disables the terminal keypad.
+
+
 .. _curses-window-objects:
 
@@ -605 +650 @@
 
 
-.. method:: window.addch([y, x,] ch[, attr])
+.. method:: window.addch(ch[, attr])
+            window.addch(y, x, ch[, attr])
 
    .. note::
 
-      A *character* means a C character (an ASCII code), rather then a Python
+      A *character* means a C character (an ASCII code), rather than a Python
       character (a string of length 1). (This note is true whenever the
       documentation mentions a character.) The built-in :func:`ord` is handy for
@@ -619 +665 @@
 
 
-.. method:: window.addnstr([y, x,] str, n[, attr])
+.. method:: window.addnstr(str, n[, attr])
+            window.addnstr(y, x, str, n[, attr])
 
    Paint at most *n* characters of the  string *str* at ``(y, x)`` with attributes
@@ -625 +672 @@
 
 
-.. method:: window.addstr([y, x,] str[, attr])
+.. method:: window.addstr(str[, attr])
+            window.addstr(y, x, str[, attr])
 
    Paint the string *str* at ``(y, x)`` with attributes *attr*, overwriting
@@ -651 +699 @@
 .. method:: window.bkgd(ch[, attr])
 
-   Sets the background property of the window to the character *ch*, with
+   Set the background property of the window to the character *ch*, with
    attributes *attr*.  The change is then applied to every character position in
    that window:
@@ -664 +712 @@
 .. method:: window.bkgdset(ch[, attr])
 
-   Sets the window's background.  A window's background consists of a character and
+   Set the window's background.  A window's background consists of a character and
    any combination of attributes.  The attribute part of the background is combined
    (OR'ed) with all non-blank characters that are written into the window.  Both
@@ -709 +757 @@
 
    Similar to :meth:`border`, but both *ls* and *rs* are *vertch* and both *ts* and
-   bs are *horch*.  The default corner characters are always used by this function.
-
-
-.. method:: window.chgat([y, x, ] [num,] attr)
-
-   Sets the attributes of *num* characters at the current cursor position, or at
+   *bs* are *horch*.  The default corner characters are always used by this function.
+
+
+.. method:: window.chgat(attr)
+            window.chgat(num, attr)
+            window.chgat(y, x, attr)
+            window.chgat(y, x, num, attr)
+
+   Set the attributes of *num* characters at the current cursor position, or at
    position ``(y, x)`` if supplied. If no value of *num* is given or *num* = -1,
    the attribute will  be set on all the characters to the end of the line.  This
@@ -724 +775 @@
 .. method:: window.clear()
 
-   Like :meth:`erase`, but also causes the whole window to be repainted upon next
+   Like :meth:`erase`, but also cause the whole window to be repainted upon next
    call to :meth:`refresh`.
 
@@ -747 +798 @@
 .. method:: window.cursyncup()
 
-   Updates the current cursor position of all the ancestors of the window to
+   Update the current cursor position of all the ancestors of the window to
    reflect the current cursor position of the window.
 
@@ -758 +809 @@
 .. method:: window.deleteln()
 
-   Delete the line under the cursor. All following lines are moved up by 1 line.
-
-
-.. method:: window.derwin([nlines, ncols,] begin_y, begin_x)
+   Delete the line under the cursor. All following lines are moved up by one line.
+
+
+.. method:: window.derwin(begin_y, begin_x)
+            window.derwin(nlines, ncols, begin_y, begin_x)
 
    An abbreviation for "derive window", :meth:`derwin` is the same as calling
    :meth:`subwin`, except that *begin_y* and *begin_x* are relative to the origin
-   of the window, rather than relative to the entire screen.  Returns a window
+   of the window, rather than relative to the entire screen.  Return a window
    object for the derived window.
 
@@ -777 +829 @@
 .. method:: window.enclose(y, x)
 
-   Tests whether the given pair of screen-relative character-cell coordinates are
-   enclosed by the given window, returning true or false.  It is useful for
+   Test whether the given pair of screen-relative character-cell coordinates are
+   enclosed by the given window, returning ``True`` or ``False``.  It is useful for
    determining what subset of the screen windows enclose the location of a mouse
    event.
@@ -791 +843 @@
 
    Return a tuple ``(y, x)`` of co-ordinates of upper-left corner.
+
+
+.. method:: window.getbkgd()
+
+   Return the given window's current background character/attribute pair.
 
 
@@ -815 +872 @@
 .. method:: window.getparyx()
 
-   Returns the beginning coordinates of this window relative to its parent window
-   into two integer variables y and x.  Returns ``-1,-1`` if this window has no
+   Return the beginning coordinates of this window relative to its parent window
+   into two integer variables y and x.  Return ``-1, -1`` if this window has no
    parent.
 
@@ -831 +888 @@
 
 
-.. method:: window.hline([y, x,] ch, n)
+.. method:: window.hline(ch, n)
+            window.hline(y, x, ch, n)
 
    Display a horizontal line starting at ``(y, x)`` with length *n* consisting of
@@ -839 +897 @@
 .. method:: window.idcok(flag)
 
-   If *flag* is false, curses no longer considers using the hardware insert/delete
-   character feature of the terminal; if *flag* is true, use of character insertion
+   If *flag* is ``False``, curses no longer considers using the hardware insert/delete
+   character feature of the terminal; if *flag* is ``True``, use of character insertion
    and deletion is enabled.  When curses is first initialized, use of character
    insert/delete is enabled by default.
@@ -853 +911 @@
 .. method:: window.immedok(flag)
 
-   If *flag* is true, any change in the window image automatically causes the
+   If *flag* is ``True``, any change in the window image automatically causes the
    window to be refreshed; you no longer have to call :meth:`refresh` yourself.
    However, it may degrade performance considerably, due to repeated calls to
@@ -865 +923 @@
 
 
-.. method:: window.insch([y, x,] ch[, attr])
+.. method:: window.insch(ch[, attr])
+            window.insch(y, x, ch[, attr])
 
    Paint character *ch* at ``(y, x)`` with attributes *attr*, moving the line from
@@ -873 +932 @@
 .. method:: window.insdelln(nlines)
 
-   Inserts *nlines* lines into the specified window above the current line.  The
+   Insert *nlines* lines into the specified window above the current line.  The
    *nlines* bottom lines are lost.  For negative *nlines*, delete *nlines* lines
    starting with the one under the cursor, and move the remaining lines up.  The
@@ -882 +941 @@
 .. method:: window.insertln()
 
-   Insert a blank line under the cursor. All following lines are moved down by 1
+   Insert a blank line under the cursor. All following lines are moved down by one
    line.
 
 
-.. method:: window.insnstr([y, x,] str, n [, attr])
+.. method:: window.insnstr(str, n[, attr])
+            window.insnstr(y, x, str, n[, attr])
 
    Insert a character string (as many characters as will fit on the line) before
@@ -895 +955 @@
 
 
-.. method:: window.insstr([y, x, ] str [, attr])
+.. method:: window.insstr(str[, attr])
+            window.insstr(y, x, str[, attr])
 
    Insert a character string (as many characters as will fit on the line) before
@@ -903 +964 @@
 
 
-.. method:: window.instr([y, x] [, n])
-
-   Returns a string of characters, extracted from the window starting at the
+.. method:: window.instr([n])
+            window.instr(y, x[, n])
+
+   Return a string of characters, extracted from the window starting at the
    current cursor position, or at *y*, *x* if specified. Attributes are stripped
-   from the characters.  If *n* is specified, :meth:`instr` returns return a string
+   from the characters.  If *n* is specified, :meth:`instr` returns a string
    at most *n* characters long (exclusive of the trailing NUL).
 
@@ -913 +975 @@
 .. method:: window.is_linetouched(line)
 
-   Returns true if the specified line was modified since the last call to
-   :meth:`refresh`; otherwise returns false.  Raises a :exc:`curses.error`
+   Return ``True`` if the specified line was modified since the last call to
+   :meth:`refresh`; otherwise return ``False``.  Raise a :exc:`curses.error`
    exception if *line* is not valid for the given window.
 
@@ -920 +982 @@
 .. method:: window.is_wintouched()
 
-   Returns true if the specified window was modified since the last call to
-   :meth:`refresh`; otherwise returns false.
+   Return ``True`` if the specified window was modified since the last call to
+   :meth:`refresh`; otherwise return ``False``.
 
 
@@ -947 +1009 @@
 .. method:: window.mvderwin(y, x)
 
-   Moves the window inside its parent window.  The screen-relative parameters of
+   Move the window inside its parent window.  The screen-relative parameters of
    the window are not changed.  This routine is used to display different parts of
    the parent window at the same physical position on the screen.
@@ -1005 +1067 @@
 .. method:: window.putwin(file)
 
-   Writes all data associated with the window into the provided file object.  This
+   Write all data associated with the window into the provided file object.  This
    information can be later retrieved using the :func:`getwin` function.
 
@@ -1011 +1073 @@
 .. method:: window.redrawln(beg, num)
 
-   Indicates that the *num* screen lines, starting at line *beg*, are corrupted and
+   Indicate that the *num* screen lines, starting at line *beg*, are corrupted and
    should be completely redrawn on the next :meth:`refresh` call.
 
@@ -1017 +1079 @@
 .. method:: window.redrawwin()
 
-   Touches the entire window, causing it to be completely redrawn on the next
+   Touch the entire window, causing it to be completely redrawn on the next
    :meth:`refresh` call.
 
@@ -1038 +1100 @@
 
 
+.. method:: window.resize(nlines, ncols)
+
+   Reallocate storage for a curses window to adjust its dimensions to the
+   specified values.  If either dimension is larger than the current values, the
+   window's data is filled with blanks that have the current background
+   rendition (as set by :meth:`bkgdset`) merged into them.
+
+
 .. method:: window.scroll([lines=1])
 
@@ -1045 +1115 @@
 .. method:: window.scrollok(flag)
 
-   Controls what happens when the cursor of a window is moved off the edge of the
+   Control what happens when the cursor of a window is moved off the edge of the
    window or scrolling region, either as a result of a newline action on the bottom
    line, or typing the last character of the last line.  If *flag* is false, the
@@ -1070 +1140 @@
 
 
-.. method:: window.subpad([nlines, ncols,] begin_y, begin_x)
+.. method:: window.subpad(begin_y, begin_x)
+            window.subpad(nlines, ncols, begin_y, begin_x)
 
    Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and
@@ -1076 +1147 @@
 
 
-.. method:: window.subwin([nlines, ncols,] begin_y, begin_x)
+.. method:: window.subwin(begin_y, begin_x)
+            window.subwin(nlines, ncols, begin_y, begin_x)
 
    Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and
@@ -1087 +1159 @@
 .. method:: window.syncdown()
 
-   Touches each location in the window that has been touched in any of its ancestor
+   Touch each location in the window that has been touched in any of its ancestor
    windows.  This routine is called by :meth:`refresh`, so it should almost never
    be necessary to call it manually.
@@ -1094 +1166 @@
 .. method:: window.syncok(flag)
 
-   If called with *flag* set to true, then :meth:`syncup` is called automatically
+   If called with *flag* set to ``True``, then :meth:`syncup` is called automatically
    whenever there is a change in the window.
 
@@ -1100 +1172 @@
 .. method:: window.syncup()
 
-   Touches all locations in ancestors of the window that have been changed in  the
+   Touch all locations in ancestors of the window that have been changed in  the
    window.
 
@@ -1106 +1178 @@
 .. method:: window.timeout(delay)
 
-   Sets blocking or non-blocking read behavior for the window.  If *delay* is
+   Set blocking or non-blocking read behavior for the window.  If *delay* is
    negative, blocking read is used (which will wait indefinitely for input).  If
    *delay* is zero, then non-blocking read is used, and -1 will be returned by
@@ -1129 +1201 @@
 .. method:: window.untouchwin()
 
-   Marks all lines in  the  window  as unchanged since the last call to
+   Mark all lines in  the  window  as unchanged since the last call to
    :meth:`refresh`.
 
 
-.. method:: window.vline([y, x,] ch, n)
+.. method:: window.vline(ch, n)
+            window.vline(y, x, ch, n)
 
    Display a vertical line starting at ``(y, x)`` with length *n* consisting of the
@@ -1176 +1249 @@
 +------------------+-------------------------------+
 | ``A_NORMAL``     | Normal attribute.             |
++------------------+-------------------------------+
+| ``A_REVERSE``    | Reverse background and        |
+|                  | foreground colors.            |
 +------------------+-------------------------------+
 | ``A_STANDOUT``   | Standout mode.                |
@@ -1585 +1661 @@
       is done on the result. This method returns the window contents as a
       string; whether blanks in the window are included is affected by the
-      :attr:`stripspaces` member.
+      :attr:`stripspaces` attribute.
 
 
@@ -1651 +1727 @@
    .. method:: gather()
 
-      This method returns the window contents as a string; whether blanks in the
+      Return the window contents as a string; whether blanks in the
       window are included is affected by the :attr:`stripspaces` member.
 
@@ -1657 +1733 @@
    .. attribute:: stripspaces
 
-      This data member is a flag which controls the interpretation of blanks in
+      This attribute is a flag which controls the interpretation of blanks in
       the window.  When it is on, trailing blanks on each line are ignored; any
       cursor motion that would land the cursor on a trailing blank goes to the
@@ -1663 +1739 @@
       contents are gathered.
 
-
-:mod:`curses.wrapper` --- Terminal handler for curses programs
-==============================================================
-
-.. module:: curses.wrapper
-   :synopsis: Terminal configuration wrapper for curses programs.
-.. moduleauthor:: Eric Raymond <esr@thyrsus.com>
-.. sectionauthor:: Eric Raymond <esr@thyrsus.com>
-
-
-.. versionadded:: 1.6
-
-This module supplies one function, :func:`wrapper`, which runs another function
-which should be the rest of your curses-using application.  If the application
-raises an exception, :func:`wrapper` will restore the terminal to a sane state
-before re-raising the exception and generating a traceback.
-
-
-.. function:: wrapper(func, ...)
-
-   Wrapper function that initializes curses and calls another function, *func*,
-   restoring normal keyboard/screen behavior on error. The callable object *func*
-   is then passed the main window 'stdscr' as its first argument, followed by any
-   other arguments passed to :func:`wrapper`.
-
-Before calling the hook function, :func:`wrapper` turns on cbreak mode, turns
-off echo, enables the terminal keypad, and initializes colors if the terminal
-has color support.  On exit (whether normally or by exception) it restores
-cooked mode, turns on echo, and disables the terminal keypad.
-