about summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/calsys.yo21
-rw-r--r--Doc/Zsh/contrib.yo31
-rw-r--r--Doc/Zsh/grammar.yo51
-rw-r--r--Doc/Zsh/options.yo30
-rw-r--r--Doc/Zsh/zle.yo20
5 files changed, 87 insertions, 66 deletions
diff --git a/Doc/Zsh/calsys.yo b/Doc/Zsh/calsys.yo
index 7dc51ab11..0d7abbf86 100644
--- a/Doc/Zsh/calsys.yo
+++ b/Doc/Zsh/calsys.yo
@@ -547,35 +547,36 @@ and status 2 if the wrong number of arguments were passed; it also sets the
 parameter tt(reply) to an empty associative array.  Otherwise,
 it returns status 0 and sets elements of the associative
 array tt(reply) as follows:
+
 startsitem()
-sitem(time)(The time as a string of digits in the same units as
+sitem(tt(time))(The time as a string of digits in the same units as
 tt($EPOCHSECONDS))
-sitem(schedtime)(The regularly scheduled time.  This may differ from
+sitem(tt(schedtime))(The regularly scheduled time.  This may differ from
 the actual event time tt(time) if this is a recurring event and the next
 occurrence has been rescheduled.  Then tt(time) gives the actual time
 and tt(schedtime) the time of the regular recurrence before modification.)
-sitem(text1)(The text from the line not including the date and time of the
+sitem(tt(text1))(The text from the line not including the date and time of the
 event, but including any tt(WARN) or tt(RPT) keywords and values.)
-sitem(warntime)(Any warning time given by the tt(WARN) keyword as a string
+sitem(tt(warntime))(Any warning time given by the tt(WARN) keyword as a string
 of digits containing the time at which to warn in the same units as
 tt($EPOCHSECONDS).  (Note this is an absolute time, not the relative time
 passed down.)  Not set no tt(WARN) keyword and value were
 matched.)
-sitem(warnstr)(The raw string matched after the tt(WARN) keyword, else unset.)
-sitem(rpttime)(Any recurrence time given by the tt(RPT) keyword as a string
+sitem(tt(warnstr))(The raw string matched after the tt(WARN) keyword, else unset.)
+sitem(tt(rpttime))(Any recurrence time given by the tt(RPT) keyword as a string
 of digits containing the time of the recurrence in the same units
 as tt($EPOCHSECONDS).  (Note this is an absolute time.)  Not set if
 no tt(RPT) keyword and value were matched.)
-sitem(schedrpttime)(The next regularly scheduled occurrence of a recurring
+sitem(tt(schedrpttime))(The next regularly scheduled occurrence of a recurring
 event before modification.  This may differ from tt(rpttime), which is the
 actual time of the event that may have been rescheduled from the regular
 time.)
-sitem(rptstr)(The raw string matched after the tt(RPT) keyword, else unset.)
-sitem(text2)(The text from the line after removal of the date and any
+sitem(tt(rptstr))(The raw string matched after the tt(RPT) keyword, else unset.)
+sitem(tt(text2))(The text from the line after removal of the date and any
 keywords and values.)
 )
 endsitem()
-)
+
 findex(calendar_showdate)
 item(tt(calendar_showdate) [ tt(-r) ] [ tt(-f) var(fmt) ] var(date-spec ...))(
 The given var(date-spec) is interpreted and the corresponding date and
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index af300fd86..2fcfbbdc7 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -3411,21 +3411,22 @@ by the prompt theme system (ifzman(see above)\
 ifnzman(noderef(Prompt Themes))).  You seldom should need to run
 tt(colors) more than once.
 
-The eight base colors are: black, red, green, yellow, blue, magenta, cyan,
-and white.  Each of these has codes for foreground and background.  In
-addition there are eight intensity attributes: bold, faint, standout,
-underline, blink, reverse, and conceal.  Finally, there are six codes used
-to negate attributes: none (reset all attributes to the defaults), normal
-(neither bold nor faint), no-standout, no-underline, no-blink, and
-no-reverse.
+The eight base colors are: tt(black), tt(red), tt(green), tt(yellow),
+tt(blue), tt(magenta), tt(cyan), and tt(white).  Each of these has codes for
+foreground and background.  In addition there are seven intensity attributes:
+tt(bold), tt(faint), tt(standout), tt(underline), tt(blink), tt(reverse),
+and tt(conceal).  Finally, there are seven codes used to negate attributes:
+tt(none) (reset all attributes to the defaults), tt(normal)
+(neither bold nor faint), tt(no-standout), tt(no-underline), tt(no-blink),
+tt(no-reverse), and tt(no-conceal).
 
 Some terminals do not support all combinations of colors and intensities.
 
 The associative arrays are:
 
 startitem()
-xitem(color)
-item(colour)(
+xitem(tt(color))
+item(tt(colour))(
 Map all the color names to their integer codes, and integer codes to the
 color names.  The eight base names map to the foreground color codes, as
 do names prefixed with `tt(fg-)', such as `tt(fg-red)'.  Names prefixed
@@ -3436,16 +3437,16 @@ and the tt(bg-) form for backgrounds.
 Although it is a misnomer to call them `colors', these arrays also map the
 other fourteen attributes from names to codes and codes to names.
 )
-xitem(fg)
-xitem(fg_bold)
-item(fg_no_bold)(
+xitem(tt(fg))
+xitem(tt(fg_bold))
+item(tt(fg_no_bold))(
 Map the eight basic color names to ANSI terminal escape sequences that set
 the corresponding foreground text properties.  The tt(fg) sequences change
 the color without changing the eight intensity attributes.
 )
-xitem(bg)
-xitem(bg_bold)
-item(bg_no_bold)(
+xitem(tt(bg))
+xitem(tt(bg_bold))
+item(tt(bg_no_bold))(
 Map the eight basic color names to ANSI terminal escape sequences that set
 the corresponding background properties.  The tt(bg) sequences change the
 color without changing the eight intensity attributes.
diff --git a/Doc/Zsh/grammar.yo b/Doc/Zsh/grammar.yo
index 932649857..719f06a97 100644
--- a/Doc/Zsh/grammar.yo
+++ b/Doc/Zsh/grammar.yo
@@ -465,37 +465,38 @@ shell constructs such as loops or conditions; this somewhat illogical
 behaviour can be recovered by setting the option tt(CONTINUE_ON_ERROR).
 
 Fatal errors found in non-interactive shells include:
-startlist()
-list(Failure to parse shell options passed when invoking the shell)
-list(Failure to change options with the tt(set) builtin)
-list(Parse errors of all sorts, including failures to parse
+
+startitemize()
+itemiz(Failure to parse shell options passed when invoking the shell)
+itemiz(Failure to change options with the tt(set) builtin)
+itemiz(Parse errors of all sorts, including failures to parse
 mathematical expressions)
-list(Failures to set or modify variable behaviour with tt(typeset),
+itemiz(Failures to set or modify variable behaviour with tt(typeset),
 tt(local), tt(declare), tt(export), tt(integer), tt(float))
-list(Execution of incorrectly positioned loop control structures
+itemiz(Execution of incorrectly positioned loop control structures
 (tt(continue), tt(break)))
-list(Attempts to use regular expression with no regular expression
+itemiz(Attempts to use regular expression with no regular expression
 module available)
-list(Disallowed operations when the tt(RESTRICTED) options is set)
-list(Failure to create a pipe needed for a pipeline)
-list(Failure to create a multio)
-list(Failure to autoload a module needed for a declared shell feature)
-list(Errors creating command or process substitutions)
-list(Syntax errors in glob qualifiers)
-list(File generation errors where not caught by the option tt(BAD_PATTERN))
-list(All bad patterns used for matching within case statements)
-list(File generation failures where not caused by tt(NO_MATCH) or
+itemiz(Disallowed operations when the tt(RESTRICTED) options is set)
+itemiz(Failure to create a pipe needed for a pipeline)
+itemiz(Failure to create a multio)
+itemiz(Failure to autoload a module needed for a declared shell feature)
+itemiz(Errors creating command or process substitutions)
+itemiz(Syntax errors in glob qualifiers)
+itemiz(File generation errors where not caught by the option tt(BAD_PATTERN))
+itemiz(All bad patterns used for matching within case statements)
+itemiz(File generation failures where not caused by tt(NO_MATCH) or
 similar options)
-list(All file generation errors where the pattern was used to create a
+itemiz(All file generation errors where the pattern was used to create a
 multio)
-list(Memory errors where detected by the shell)
-list(Invalid subscripts to shell variables)
-list(Attempts to assign read-only variables)
-list(Logical errors with variables such as assignment to the wrong type)
-list(Use of invalid variable names)
-list(Errors in variable substitution syntax)
-list(Failure to convert characters in tt($')...tt(') expressions)
-endlist()
+itemiz(Memory errors where detected by the shell)
+itemiz(Invalid subscripts to shell variables)
+itemiz(Attempts to assign read-only variables)
+itemiz(Logical errors with variables such as assignment to the wrong type)
+itemiz(Use of invalid variable names)
+itemiz(Errors in variable substitution syntax)
+itemiz(Failure to convert characters in tt($')...tt(') expressions)
+enditemize()
 
 If the tt(POSIX_BUILTINS) option is set, more errors associated with
 shell builtin commands are treated as fatal, as specified by the POSIX
diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index 349946d82..7788cd755 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -971,6 +971,23 @@ The file will still be periodically re-written to trim it when the
 number of lines grows 20% beyond the value specified by
 tt($SAVEHIST) (see also the HIST_SAVE_BY_COPY option).
 )
+pindex(INC_APPEND_HISTORY_TIME)
+pindex(NO_INC_APPEND_HISTORY_TIME)
+pindex(INCAPPENDHISTORYTIME)
+pindex(NOINCAPPENDHISTORYTIME)
+cindex(history, incremental appending to a file with time)
+item(tt(INC_APPEND_HISTORY_TIME))(
+This option is a variant of tt(INC_APPEND_HISTORY) in which, where
+possible, the history entry is written out to the file after the
+command is finished, so that the time taken by the command is recorded
+correctly in the history file in tt(EXTENDED_HISTORY) format.  This
+means that the history entry will not be available immediately from
+other instances of the shell that are using the same history file.
+
+This option is only useful if tt(INC_APPEND_HISTORY) and
+tt(SHARE_HISTORY) are turned off.  The three options should be
+considered mutually exclusive.
+)
 pindex(SHARE_HISTORY)
 pindex(NO_SHARE_HISTORY)
 pindex(SHAREHISTORY)
@@ -981,10 +998,10 @@ item(tt(SHARE_HISTORY) <K>)(
 
 This option both imports new commands from the history file, and also
 causes your typed commands to be appended to the history file (the
-latter is like specifying tt(INC_APPEND_HISTORY)).
-The history lines are also output with timestamps ala
-tt(EXTENDED_HISTORY) (which makes it easier to find the spot where
-we left off reading the file after it gets re-written).
+latter is like specifying tt(INC_APPEND_HISTORY), which should be turned
+off if this option is in effect).  The history lines are also output
+with timestamps ala tt(EXTENDED_HISTORY) (which makes it easier to find
+the spot where we left off reading the file after it gets re-written).
 
 By default, history movement commands visit the imported lines as
 well as the local lines, but you can toggle this on and off with the
@@ -994,8 +1011,9 @@ some include them.
 
 If you find that you want more control over when commands
 get imported, you may wish to turn tt(SHARE_HISTORY) off,
-tt(INC_APPEND_HISTORY) on, and then manually import
-commands whenever you need them using `tt(fc -RI)'.
+tt(INC_APPEND_HISTORY) or tt(INC_APPEND_HISTORY_TIME) (see above) on,
+and then manually import commands whenever you need them using `tt(fc
+-RI)'.
 )
 enditem()
 
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 4b1022614..2a907c52c 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -732,16 +732,16 @@ The context in which zle was called to read a line; read-only.  One of
 the values:
 
 startitem()
-item(start)(
+item(tt(start))(
 The start of a command line (at prompt tt(PS1)).
 )
-item(cont)(
+item(tt(cont))(
 A continuation to a command line (at prompt tt(PS2)).
 )
-item(select)(
+item(tt(select))(
 In a tt(select) loop.
 )
-item(vared)(
+item(tt(vared))(
 Editing a variable in tt(vared).
 )
 enditem()
@@ -878,21 +878,21 @@ is needed for character indexing to include tt(PREDISPLAY).
 
 Each string consists of the following parts:
 
-startlist()
-list(Optionally, a `tt(P)' to signify that the start and end offset that
+startitemize()
+itemiz(Optionally, a `tt(P)' to signify that the start and end offset that
 follow include any string set by the tt(PREDISPLAY) special parameter;
 this is needed if the predisplay string itself is to be highlighted.
 Whitespace may follow the `tt(P)'.)
-list(A start offset in the same units as tt(CURSOR), terminated by
+itemiz(A start offset in the same units as tt(CURSOR), terminated by
 whitespace.)
-list(An end offset in the same units as tt(CURSOR), terminated by
+itemiz(An end offset in the same units as tt(CURSOR), terminated by
 whitespace.)
-list(A highlight specification in the same format as
+itemiz(A highlight specification in the same format as
 used for contexts in the parameter tt(zle_highlight),
 ifnzman(noderef(Character Highlighting))\
 ifzman(see Character Highlighting below);
 for example, tt(standout) or tt(fg=red,bold)).
-endlist()
+enditemize()
 
 For example,