Document the new PROMPT_SP option.

1 files changed, 18 insertions, 0 deletions

diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index fd21265ed..4465eb77e 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -906,6 +906,24 @@ Print a carriage return just before printing
 a prompt in the line editor.  This is on by default as multi-line editing
 is only possible if the editor knows where the start of the line appears.
 )
+pindex(PROMPT_SP)
+cindex(prompt, save partial lines)
+item(tt(PROMPT_SP) (tt(PLUS()V)) <D>)(
+Attempt to preserve a partial line (i.e. a line that did not end with a
+newline) that would otherwise be covered up by the command prompt due to
+the PROMPT_CR option.  This works by outputting some cursor-control
+characters, including a series of spaces, that should make the terminal
+wrap to the next line when a partial line is present (note that this is
+only successful if your terminal has automatic margins, which is typical).
+
+One potential side-effect can affect the selection of text from a partial
+line using the mouse:  triple-clicking may select more text than you
+expected, or the spaces following a partial line may be selectable where
+they would not be if the line had actually ended with a newline.
+
+NOTE: if the PROMPT_CR option is not set, enabling this option will have no
+effect.  This option is on by default.
+)
 pindex(PROMPT_PERCENT)
 cindex(prompt, % expansion)
 item(tt(PROMPT_PERCENT) <C> <Z>)(