about summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2009-05-17 18:23:09 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2009-05-17 18:23:09 +0000
commita4106e0523036bff9eb1556629bd44a359444d93 (patch)
tree0bb6abc51e4b71b1cf75e69dc3d7b678976e4ae4 /Doc
parent9169cd747f81bf1053e4d230ef1efdfd5aedb642 (diff)
downloadzsh-a4106e0523036bff9eb1556629bd44a359444d93.tar.gz
zsh-a4106e0523036bff9eb1556629bd44a359444d93.tar.xz
zsh-a4106e0523036bff9eb1556629bd44a359444d93.zip
Greg Klanderman: 26964 (modified): PROMPT_EOL_MARK
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/options.yo12
-rw-r--r--Doc/Zsh/params.yo12
2 files changed, 17 insertions, 7 deletions
diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index 0a03c8272..c9e9b7be5 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -1307,16 +1307,18 @@ cindex(prompt, save partial lines)
 item(tt(PROMPT_SP) <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
+the tt(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).
 
-When a partial line is preserved, you will see an inverse+bold character at
-the end of the partial line:  a "%" for a normal user or a "#" for root.
+When a partial line is preserved, by default you will see an inverse+bold
+character at the end of the partial line:  a "%" for a normal user or
+a "#" for root.  If set, the shell parameter tt(PROMPT_EOL_MARK) can be
+used to customize how the end of partial lines are shown.
 
-NOTE: if the PROMPT_CR option is not set, enabling this option will have no
-effect.  This option is on by default.
+NOTE: if the tt(PROMPT_CR) option is not set, enabling this option will
+have no effect.  This option is on by default.
 )
 pindex(PROMPT_PERCENT)
 pindex(NO_PROMPT_PERCENT)
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index e36becf53..f77d36db4 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -1043,13 +1043,21 @@ vindex(prompt)
 item(tt(prompt) <S> <Z>)(
 Same as tt(PS1).
 )
+vindex(PROMPT_EOL_MARK)
+item(tt(PROMPT_EOL_MARK))(
+When the tt(PROMPT_CR) and tt(PROMPT_SP) options are set, the
+tt(PROMPT_EOL_MARK) parameter can be used to customize how the end of
+partial lines are shown.  This parameter undergoes prompt expansion, with
+the tt(PROMPT_PERCENT) option set.  If not set or empty, the default
+behavior is equivalent to the value `tt(%B%S%#%s%b)'.
+)
 vindex(PS1)
 item(tt(PS1) <S>)(
 The primary prompt string, printed before a command is read.
-the default is `tt(%m%# )'.  It undergoes a special form of expansion
+It undergoes a special form of expansion
 before being displayed; see
 ifzman(EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
-ifnzman(noderef(Prompt Expansion)).
+ifnzman(noderef(Prompt Expansion)).  The default is `tt(%m%# )'.
 )
 vindex(PS2)
 item(tt(PS2) <S>)(