summaryrefslogtreecommitdiffstats
path: root/Doc/Zsh/prompt.yo
diff options
context:
space:
mode:
authorJun-ichi Takimoto <takimoto-j@kba.biglobe.ne.jp>2025-07-18 23:26:56 +0900
committerJun-ichi Takimoto <takimoto-j@kba.biglobe.ne.jp>2025-07-18 23:26:56 +0900
commit33aafecc7e9e3224e0283fe8be098ede39f48f61 (patch)
tree8e3241dc4d09c55e891933c7aeeaebefa8c7004a /Doc/Zsh/prompt.yo
parent53820: detect integer overflow when parsing history word designators. (diff)
downloadzsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar.gz
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar.bz2
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar.lz
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar.xz
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.tar.zst
zsh-33aafecc7e9e3224e0283fe8be098ede39f48f61.zip
53821: add missing manpage name in cross reference
and many small improvements. See comments in zman.yo for the usage of new yodl macros for cross reference.
Diffstat (limited to 'Doc/Zsh/prompt.yo')
-rw-r--r--Doc/Zsh/prompt.yo31
1 files changed, 17 insertions, 14 deletions
diff --git a/Doc/Zsh/prompt.yo b/Doc/Zsh/prompt.yo
index 108cb62e5..9b713ce4a 100644
--- a/Doc/Zsh/prompt.yo
+++ b/Doc/Zsh/prompt.yo
@@ -1,5 +1,6 @@
texinode(Prompt Expansion)(Expansion)(Conditional Expressions)(Top)
chapter(Prompt Expansion)
+anchor(Expansion of Prompt Sequences)
sect(Expansion of Prompt Sequences)
cindex(prompt expansion)
cindex(expansion, prompt)
@@ -29,15 +30,18 @@ represented as `tt(!!)'.
pindex(PROMPT_PERCENT, use of)
If the tt(PROMPT_PERCENT) option is set, certain escape sequences that
start with `tt(%)' are expanded.
-Many escapes are followed by a single character, although some of these
+Many escapes (see sectref(Simple Prompt Escapes)(below))
+are followed by a single character, although some of these
take an optional integer argument that
should appear between the `tt(%)' and the next character of the
-sequence. More complicated escape sequences are available to provide
-conditional expansion.
+sequence. More complicated escape sequences
+(see sectref(Conditional Substrings in Prompts)(below))
+are available to provide conditional expansion.
+anchor(Simple Prompt Escapes)
sect(Simple Prompt Escapes)
-subsect(Special characters)
+subsect(Special Characters)
startitem()
item(tt(%%))(
A `tt(%)'.
@@ -47,7 +51,7 @@ A `tt(RPAR())'.
)
enditem()
-subsect(Login information)
+subsect(Login Information)
startitem()
item(tt(%l))(
The line (tty) the user is logged in on, without `tt(/dev/)' prefix.
@@ -71,7 +75,7 @@ This does not treat `tt(/dev/tty)' names specially.
)
enditem()
-subsect(Shell state)
+subsect(Shell State)
startitem()
item(tt(%#))(
A `tt(#)' if the shell is running with privileges, a `tt(%)' if not.
@@ -108,9 +112,8 @@ As tt(%d) and tt(%/), but if the current working directory starts with
tt($HOME), that part is replaced by a `tt(~)'. Furthermore, if it has a named
directory as its prefix, that part is replaced by a `tt(~)' followed by
the name of the directory, but only if the result is shorter than
-the full path;
-ifzman(see em(Dynamic) and em(Static named directories) in zmanref(zshexpn))\
-ifnzman(noderef(Filename Expansion)).
+the full path; see bf(Dynamic) and bf(Static Named Directories) in
+sectref(Filename Expansion)(zshexpn).
)
item(tt(%e))(
Evaluation depth of the current sourced file, shell function, or tt(eval).
@@ -162,7 +165,7 @@ the latter two sequences.
)
enditem()
-subsect(Date and time)
+subsect(Date and Time)
startitem()
item(tt(%D))(
The date in var(yy)tt(-)var(mm)tt(-)var(dd) format.
@@ -218,7 +221,7 @@ and may work if the system supports them.
)
enditem()
-subsect(Visual effects)
+subsect(Visual Effects)
startitem()
item(tt(%B) LPAR()tt(%b)RPAR())(
Start (stop) boldface mode.
@@ -238,9 +241,8 @@ by the terminal. The colour may be specified two ways: either
as a numeric argument, as normal, or by a sequence in braces
following the tt(%F), for example tt(%F{red}). In the latter case
the values allowed are as described for the tt(fg) tt(zle_highlight)
-attribute;
-ifzman(see em(Character Highlighting) in zmanref(zshzle))\
-ifnzman(noderef(Character Highlighting)). This means that numeric
+attribute; see sectref(Character Highlighting)(zshzle).
+This means that numeric
colours are allowed in the second format also.
)
item(tt(%K) LPAR()tt(%k)RPAR())(
@@ -284,6 +286,7 @@ the correct truncation point can be found.
)
enditem()
+anchor(Conditional Substrings in Prompts)
sect(Conditional Substrings in Prompts)
startitem()
item(tt(%v))(