summaryrefslogtreecommitdiff
path: root/Doc/zshoptions.1
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/zshoptions.1')
-rw-r--r--Doc/zshoptions.162
1 files changed, 54 insertions, 8 deletions
diff --git a/Doc/zshoptions.1 b/Doc/zshoptions.1
index fd10e8d29..c85c877ee 100644
--- a/Doc/zshoptions.1
+++ b/Doc/zshoptions.1
@@ -1,4 +1,4 @@
-.TH "ZSHOPTIONS" "1" "February 12, 2022" "zsh 5\&.8\&.1"
+.TH "ZSHOPTIONS" "1" "April 9, 2022" "zsh 5\&.8\&.1\&.2-test"
.SH "NAME"
zshoptions \- zsh options
.\" Yodl file: Zsh/options.yo
@@ -34,6 +34,9 @@ will be treated just as `\fB\-f\fP\&', but the string `\fB\-f i\fP' is an error\
This is because many systems which implement the `\fB#!\fP\&' mechanism for
calling scripts do not strip trailing whitespace\&.
.PP
+It is possible for options to be set within a function scope\&. See the
+description of the option \fBLOCAL_OPTIONS\fP below\&.
+.PP
.SH "DESCRIPTION OF OPTIONS"
In the following list, options set by default in all emulations are marked
<D>; those set by default only in csh, ksh, sh, or zsh emulations are marked
@@ -289,6 +292,19 @@ can match the directory \fBCVS\fP owing to the presence of the globbing flag
Make regular expressions using the \fBzsh/regex\fP module (including
matches with \fB=~\fP) sensitive to case\&.
.TP
+\fBCASE_PATHS\fP
+If \fBCASE_PATHS\fP is not set (the default), \fBCASE_GLOB\fP affects the
+interpretation of \fIevery\fP path component, whenever a special
+character appears in \fIany\fP component\&. When \fBCASE_PATHS\fP is set,
+file path components that do \fInot\fP contain special filename
+generation characters are always sensitive to case, thus restricting
+\fBNO_CASE_GLOB\fP to components that contain globbing characters\&.
+.RS
+.PP
+Note that if the filesystem itself is not sensitive to case, then
+\fBCASE_PATHS\fP has no effect\&.
+.RE
+.TP
\fBCSH_NULL_GLOB\fP <C>
If a pattern for filename generation has no matches,
delete the pattern from the argument list;
@@ -351,7 +367,7 @@ Substitutions using the \fB:s\fP and \fB:&\fP history modifiers are performed
with pattern matching instead of string matching\&. This occurs wherever
history modifiers are valid, including glob qualifiers and parameters\&.
See
-the section Modifiers in \fIzshexpn\fP(1)\&.
+the section `Modifiers\&' in \fIzshexpn\fP(1)\&.
.TP
\fBIGNORE_BRACES\fP (\fB\-I\fP) <S>
Do not perform brace expansion\&. For historical reasons this
@@ -724,7 +740,7 @@ effect extends beyond the scope of the enclosing function; this is the
most portable way to achieve this behaviour\&.
.RE
.TP
-\fBGLOBAL_RCS\fP (\fB\-d\fP) <D>
+\fBGLOBAL_RCS\fP (\fB+d\fP) <D>
If this option is unset, the startup files \fB/etc/zprofile\fP,
\fB/etc/zshrc\fP, \fB/etc/zlogin\fP and \fB/etc/zlogout\fP will not be run\&. It
can be disabled and re\-enabled at any time, including inside local startup
@@ -757,6 +773,18 @@ not set, `\fB>>!\fP\&' or `\fB>>|\fP' must be used to create a file\&.
If either option is set, `\fB>>\fP\&' may be used\&.
.RE
.TP
+\fBCLOBBER_EMPTY\fP
+This option is only used if the option \fBCLOBBER\fP is not set: note that
+it is set by default\&.
+.RS
+.PP
+If this option is set, then regular files of zero length may be
+ovewritten (`clobbered\&')\&. Note that it is possible another process
+has written to the file between this test and use of the file by
+the current process\&. This option should therefore not be used in
+cases where files to be clobbered may be written to asynchronously\&.
+.RE
+.TP
\fBCORRECT\fP (\fB\-0\fP)
Try to correct the spelling of commands\&.
Note that, when the \fBHASH_LIST_ALL\fP option is not set or when some
@@ -881,6 +909,10 @@ avoided by expanding the `\fB*\fP\&' in ZLE (with tab)\&.
Allow the short forms of \fBfor\fP, \fBrepeat\fP, \fBselect\fP,
\fBif\fP, and \fBfunction\fP constructs\&.
.TP
+\fBSHORT_REPEAT\fP
+Allow the short form \fBrepeat\fP as \fBSHORT_LOOPS\fP but without enabling
+it for the other constructs\&.
+.TP
\fBSUN_KEYBOARD_HACK\fP (\fB\-L\fP)
If a line ends with a backquote, and there are an odd number
of backquotes on the line, ignore the trailing backquote\&.
@@ -1247,6 +1279,12 @@ If the option is set, they will only be shown when parameters are selected
with the `\fB\-m\fP\&' option\&. The option `\fB\-p\fP' is available whether or not
the option is set\&.
.TP
+\fBTYPESET_TO_UNSET\fP <K> <S>
+When declaring a new parameter with any of the `\fBtypeset\fP\&' family of
+related commands, the parameter remains unset unless and until a
+value is explicity assigned to it, either in the `\fBtypeset\fP\&' command
+itself or as a later assignment statement\&.
+.TP
\fBVERBOSE\fP (\fB\-v\fP, ksh: \fB\-v\fP)
Print shell input lines as they are read\&.
.TP
@@ -1463,7 +1501,8 @@ command found in the path\&.
.PP
Furthermore, the \fBgetopts\fP builtin behaves in a POSIX\-compatible
fashion in that the associated variable \fBOPTIND\fP is not made
-local to functions\&.
+local to functions, and its value is calculated differently to match
+other shells\&.
.PP
Moreover, the warning and special exit code from
\fB[[ \-o \fP\fInon_existent_option\fP\fB ]]\fP are suppressed\&.
@@ -1529,10 +1568,17 @@ When this option is set, the usual zsh behaviour of executing
traps for \fBEXIT\fP on exit from shell functions is suppressed\&.
In that case, manipulating \fBEXIT\fP traps always alters the global
trap for exiting the shell; the \fBLOCAL_TRAPS\fP option is
-ignored for the \fBEXIT\fP trap\&. Furthermore, a \fBreturn\fP statement
-executed in a trap with no argument passes back from the function the
-value from the surrounding context, not from code executed within the
-trap\&.
+ignored for the \fBEXIT\fP trap\&.
+.RS
+.PP
+Also, a \fBreturn\fP statement executed in a trap with no argument passes
+back from the function the value from the surrounding context, not from
+code executed within the trap\&.
+.PP
+Furthermore, if a trap is set to be ignored, this state persists when
+a subshell is entered\&. Without the option, the trap would be reset to
+its default state at this point\&.
+.RE
.TP
\fBSH_FILE_EXPANSION\fP <K> <S>
Perform filename expansion (e\&.g\&., \fB~\fP expansion) \fIbefore\fP