upstream/oracle/userland-gate: comparison components/ksh93/files/ksh.1

equal deleted inserted replaced

-:5813a4ba7644
+:55497e208813
 '\" te
 .\" Copyright (c) 1982-2007 AT&T Knowledge Ventures
 .\" To view license terms, see http://www.opensource.org/licenses/cpl1.0.txt
-.\" Portions Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
+.\" Portions Copyright (c) 2009, 2015, Oracle and/or its affiliates. All    rights reserved.
-.TH ksh 1 "4 Jan 2012" "SunOS 5.11" "User Commands"
+.TH ksh 1 "4 Feb 2015" "SunOS 5.12" "User Commands"
 .SH NAME
 ksh, ksh93, rksh \- Korn Shell, a standard and restricted command and programming language
 .SH SYNOPSIS
 .LP
 .nf
 .ne 2
 .mk
 .na
 \fB\fBCDPATH\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Defines the search path for the \fBcd\fR command.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBCOLUMNS\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Defines the width of the edit window for the shell edit modes and for printing select lists.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBEDITOR\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If the \fBVISUAL\fR variable is not set, the value of this variable is checked for the patterns as described with \fBVISUAL\fR and the corresponding editing option is turned on.
 .sp
 See the \fBset\fR command in the \fBSpecial Command\fR section of this manual page.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBENV\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Performs parameter expansion, command substitution, and arithmetic substitution on the value to generate the pathname of the script that is executed when the shell is invoked. This file is typically used for alias and function definitions. The default value is \fB$HOME/.kshrc\fR.
 .sp
 See the \fBInvocation\fR section of this manual page.
 .sp
 \fBENV\fR is not set by the shell.
 .ne 2
 .mk
 .na
 \fB\fBFCEDIT\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Obsolete name for the default editor name for the \fBhist\fR command. \fBFCEDIT\fR is not used when \fBHISTEDIT\fR is set.
 .sp
 The shell specifies a default value to \fBFCEDIT\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBFIGNORE\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 A pattern that defines the set of file names that is ignored when performing file name matching.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBFPATH\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The search path for function definitions. The directories in this path are searched for a file with the same name as the function or command when a function with the \fB-u\fR attribute is referenced and when a command is not found. If an executable file with the name of that command is found, then it is read and executed in the current environment. Unlike \fBPATH\fR, the current directory must be represented explicitly by dot (\fB\&.\fR) rather than by adjacent colon (\fB:\fR) characters or a beginning or ending colon (\fB:\fR).
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBHISTCMD\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The number of the current command in the history file.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBHISTEDIT\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The name for the default editor name for the \fBhist\fR command.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBHISTFILE\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If this variable is set when the shell is invoked, the value is the pathname of the file that is used to store the command history. See the \fBCommand Re-entry\fR section of this manual page.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBHISTSIZE\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If this variable is set when the shell is invoked, then the number of previously entered commands that are accessible by this shell is greater than or equal to this number. The default is \fB512\fR.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBHOME\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The default argument (home directory) for the \fBcd\fR command.
 .sp
 \fBHOME\fR is not set by the shell. \fBHOME\fR is set by \fBlogin\fR(1).
 .RE
 .ne 2
 .mk
 .na
 \fB\fBIFS\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Internal field separators, normally SPACE, TAB, and NEWLINE that are used to separate the results of command substitution or parameter expansion and to separate fields with the built-in command read. The first character of the \fBIFS\fR variable is used to separate arguments for the \fB"$*"\fR substitution. See the \fBQuoting\fR section of this manual page.
 .sp
 Each single occurrence of an \fBIFS\fR character in the string to be split, that is not in the \fBissspace\fR character class, and any adjacent characters in \fBIFS\fR that are in the \fBissspace\fR character class, delimit a field. One or more characters in IFS that belong to the \fBissspace\fR character class, delimit a field. In addition, if the same \fBissspace\fR character appears consecutively inside \fBIFS\fR, this character is treated as if it were not in the \fBissspace\fR class, so that if \fBIFS\fR consists of two tab characters, then two adjacent tab characters delimit a null field.
 .sp
 The shell specifies a default value to \fBIFS\fR.
 .ne 2
 .mk
 .na
 \fB\fBLANG\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 This variable determines the locale category for any category not specifically selected with a variable starting with \fBLC_\fR or \fBLANG\fR.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBLC_ALL\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 This variable overrides the value of the \fBLANG\fR variable and any other \fBLC_\fR variable.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBLC_COLLATE\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 This variable determines the locale category for character collation information.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBLC_CTYPE\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 This variable determines the locale category for character handling functions. It determines the character classes for pattern matching. See the \fBFile Name Generation\fR section of this manual page.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBLC_NUMERIC\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 This variable determines the locale category for the decimal point character.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBLINES\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If this variable is set, the value is used to determine the column length for printing select lists. Select lists prints vertically until about two-thirds of \fBLINES\fR lines are filled.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBMAIL\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If this variable is set to the name of a mail file \fBand\fR the \fBMAILPATH\fR variable is not set, then the shell informs the user of arrival of mail in the specified file.
 .sp
 \fBMAIL\fR is not set by the shell. On some systems, \fBMAIL\fR is set by \fBlogin\fR(1).
 .RE
 .ne 2
 .mk
 .na
 \fB\fBMAILCHECK\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Specifies how often in seconds the shell checks for changes in the modification time of any of the files specified by the \fBMAILPATH\fR or \fBMAIL\fR variables. The default value is \fB600\fR seconds. When the time has elapsed the shell checks before issuing the next prompt.
 .sp
 The shell specifies a default value to \fBMAILCHECK\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBMAILPATH\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 A colon ( \fB:\fR ) separated list of file names. If this variable is set, then the shell informs the user of any modifications to the specified files that have occurred within the last \fBMAILCHECK\fR seconds. Each file name can be followed by a \fB?\fR and a message that is printed. The message undergoes parameter expansion, command substitution, and arithmetic substitution with the variable \fB$_\fR defined as the name of the file that has changed. The default message is \fByou have mail in $_\fR.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBPATH\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The search path for commands. Except in \fB\&.profile\fR, users cannot change \fBPATH\fR if executing under \fBrksh\fR. See the \fBExecution\fR section of this manual page.
 .sp
 The shell specifies a default value to \fBPATH\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBPS1\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The value of this variable is expanded for parameter expansion, command substitution, and arithmetic substitution to define the primary prompt string which by default is \fB$\fR. The character \fB!\fR in the primary prompt string is replaced by the command number. Two successive occurrences of \fB!\fR produces a single \fB!\fR when the prompt string is printed. See the \fBCommand Re-entry\fR section of this manual page.
 .sp
 The shell specifies a default value to \fBPS1\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBPS2\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Secondary prompt string, by default, \fB>\fR.
 .sp
 The shell specifies a default value to \fBPS2\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBPS3\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 Selection prompt string used within a select loop, by default \fB#?\fR.
 .sp
 The shell specifies a default value to \fBPS3\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBPS4\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The value of this variable is expanded for parameter evaluation, command substitution, and arithmetic substitution and precedes each line of an execution trace. By default, \fBPS4\fR is \fB+\fR. When \fBPS4\fR is unset, the execution trace prompt is also \fB+\fR .
 .sp
 The shell specifies a default value to \fBPS4\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBSHELL\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The pathname of the shell is kept in the environment. At invocation, if the basename of this variable is \fBrsh\fR, \fBrksh\fR, \fBrksh\fR, or \fBkrsh\fR, the shell becomes restricted.
 .sp
 \fBSHELL\fR is not set by the shell. On some systems, \fBSHELL\fR is set by \fBlogin\fR(1).
 .RE
 .ne 2
 .mk
 .na
 \fB\fBTIMEFORMAT\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 The value of this parameter is used as a format string specifying how the timing information for pipelines prefixed with the \fBtime\fR reserved word should be displayed. The \fB%\fR character introduces a format sequence that is expanded to a time value or other information.
 .sp
 The format sequences and their meanings are as follows.
 .sp
 .ne 2
 The braces denote optional portions. The optional \fIp\fR is a digit specifying the \fIprecision\fR, the number of fractional digits after a decimal point. A value of \fB0\fR causes no decimal point or fraction to be output. At most three places after the decimal point can be displayed. Values of \fIp\fR greater than \fB3\fR are treated as \fB3\fR. If \fIp\fR is not specified, the value \fB3\fR is used.
 .sp
 The optional \fBl\fR specifies a longer format, including hours if greater than zero, minutes, and seconds of the form \fIHHhMMmSS.FFs\fR. The value of \fIp\fR determines whether or not the fraction is included.
 .sp
-All other characters are output without change and a trailing NEWLINE is added. If unset, the default value, \fB$'\nreal\t%2lR\nuser\t%2lU\nsys%2lS'\fR, is used. If the value is null, no timing information is displayed.
+All other characters are output without change and a trailing NEWLINE is added. If unset, the default value, \fB$'\enreal\et%2lR\enuser\et%2lU\ensys\et%2lS'\fR, is used. If the value is null, no timing information is displayed.
 .RE
 .sp
 .ne 2
 .mk
 .na
 \fB\fBTMOUT\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If set to a value greater than zero, \fBTMOUT\fR is the default time-out value for the \fBread\fR built-in command. The \fBselect\fR compound command terminates after \fBTMOUT\fR seconds when input is from a terminal. Otherwise, the shell terminates if a line is not entered within the prescribed number of seconds while reading from a terminal. The shell can be compiled with a maximum bound for this value which cannot be exceeded.
 .sp
 The shell specifies a default value to \fBTMOUT\fR.
 .RE
 .ne 2
 .mk
 .na
 \fB\fBVISUAL\fR\fR
 .ad
-.RS 14n
+.sp .6
-.rt
+.RS 4n
 If the value of this variable matches the pattern \fB*[Vv][Ii]*\fR, then the \fBvi\fR option is turned on. See \fBSpecial Commands\fR. If the value matches the pattern \fB*gmacs*\fR , the \fBgmacs\fR option is turned on. If the value matches the pattern \fB*macs*\fR, then the \fBemacs\fR option is turned on. The value of \fBVISUAL\fR overrides the value of \fBEDITOR\fR.
 .RE
 .SS "Field Splitting"
 .sp
 Treat the match as case insensitive.
 .RE
 .sp
 .LP
-If both \fIoptions\fR and \fB:\fR\fIpattern-list\fR are specified, then the options apply only to \fIpattern-list\fR. Otherwise, the options remain in effect until they are disabled by a subsequent \fB~(...)\fR or at the end of the sub-pattern containing \fB~(...)\fR.
-.sp
-.LP
 Each of the metacharacters listed in the \fBDefinitions\fR section of this manual page has a special meaning to the shell and causes termination of a word unless quoted. A character can be quoted, that is, made to stand for itself, by preceding it with a backslash (\fB\e\fR). The pair \fB\e\fRNEWLINE is removed. All characters enclosed between a pair of single quote marks (\fB\&''\fR) that is not preceded by a \fB$\fR are quoted. A single quote cannot appear within the single quotes. A single quoted string preceded by an unquoted \fB$\fR is processed as an \fBANSI-C\fR string except for the following:
 .sp
 .ne 2
 .mk
 .na
 Equivalent to the escape character (\fBASCII\fR 033),
 .RE
 .sp
 .LP
-Inside double quote marks (\fB""\fR), parameter and command substitution occur and \fB\e\fR quotes the characters \fB\e\fR, \fB`\fR, \fB"\fR, and \fB$\fR. A \fB$\fR in front of a double quoted string is ignored in the \fBC\fR or \fBPOSIX\fR locale, and might cause the string to be replaced by a locale specific string otherwise. The meaning of \fB$*\fR and \fB$@\fR is identical when not quoted or when used as a variable assignment value or as a file name. However, when used as a command argument, \fB"$*"\fR is equivalent to \fB"$1\fId\fR$2\fId\fR..."\fR, where \fId\fR is the first character of the IFS variable, whereas \fB"$@"\fR is equivalent to \fB"$1" "$2" ....\fR Inside grave quote marks (\fB``\fR), \fB\\fR quotes the characters \fB\e\fR, \fB`\fR, and \fB$\fR. If the grave quotes occur within double quotes, then \fB\e\fR also quotes the character \fB"\fR.
+Inside double quote marks (\fB""\fR), parameter and command substitution occur and \fB\e\fR quotes the characters \fB\e\fR, \fB`\fR, \fB"\fR, and \fB$\fR. A \fB$\fR in front of a double quoted string is ignored in the \fBC\fR or \fBPOSIX\fR locale, and might cause the string to be replaced by a locale specific string otherwise. The meaning of \fB$*\fR and \fB$@\fR is identical when not quoted or when used as a variable assignment value or as a file name. However, when used as a command argument, \fB"$*"\fR is equivalent to \fB"$1\fId\fR$2\fId\fR..."\fR, where \fId\fR is the first character of the IFS variable, whereas \fB"$@"\fR is equivalent to \fB"$1" "$2" ....\fR Inside grave quote marks (\fB``\fR), \fB\e\fR quotes the characters \fB\e\fR, \fB`\fR, and \fB$\fR. If the grave quotes occur within double quotes, then \fB\e\fR also quotes the character \fB"\fR.
 .sp
 .LP
 The special meaning of reserved words or aliases can be removed by quoting any character of the reserved word. The recognition of function names or built-in command names cannot be altered by quoting them.
 .SS "Arithmetic Evaluation"
 .sp
 .na
 \fB\fB-p\fR\fR
 .ad
 .sp .6
 .RS 4n
-Disables processing of the \fB$HOME/.profile\fR file and uses the file \fB/etc/suid_profile\fR instead of the \fBENV\fR file. This mode is on whenever the effective \fBuid\fR (\fBgid\fR) is not equal to the real \fBuid\fR (\fBgid\fR). Turning this off causes the effective \fBuid\fR and \fBgid\fR to be set to the real \fBuid\fR and \fBgid\fR.
+Disables processing of the \fB$HOME/.profile\fR file and uses the file \fB/etc/suid_profile\fR instead of the \fBENV\fR file. This mode is required if the effective \fBuid\fR is not equal to the real uid and you do not want the default behavior of setting the effective to be the same as the real uid. Turning this off causes the effective \fBuid\fR and \fBgid\fR to be set to the real \fBuid\fR and \fBgid\fR.
 .RE
 .sp
 .ne 2
 .mk
 .RE
 .SS "Invocation"
 .sp
 .LP
-If the shell is invoked by \fBexec\fR(2), and the first character of argument zero (\fB$0\fR) is \fB-\fR, then the shell is assumed to be a login shell and commands are read from \fB/etc/profile\fR and then from \fB$HOME/.profile\fR. Next, for interactive shells, commands are read first from \fB/etc/ksh.kshrc\fR, and then from the file named by performing parameter expansion, command substitution, and arithmetic substitution on the value of the environment variable \fBENV\fR if the file exists. If the \fB-s\fR option is not present and \fIarg\fR and a file by the name of \fIarg\fR exists, then it reads and executes this script. Otherwise, if the first \fIarg\fR does not contain a \fB/\fR, a path search is performed on the first \fIarg\fR to determine the name of the script to execute. The script \fIarg\fR must have execute permission and any \fBsetuid\fR and \fBsetgid\fR settings are ignored. If the script is not found on the path, \fIarg\fR is processed as if it named a built-in command or function.
+If the shell is invoked by \fBexec\fR(2), and the first character of argument zero (\fB$0\fR) is \fB-\fR, then the shell is assumed to be a login shell and commands are read from \fB/etc/profile\fR and then from either .\fBprofile\fR in the current directory or \fB$HOME/.profile\fR, if either file exists. Next, for interactive shells, commands are read first from \fB/etc/ksh.kshrc\fR, and then from the file named by performing parameter expansion, command substitution, and arithmetic substitution on the value of the environment variable \fBENV\fR if the file exists. If the \fB-s\fR option is not present and \fIarg\fR and a file by the name of \fIarg\fR exists, then it reads and executes this script. Otherwise, if the first \fIarg\fR does not contain a \fB/\fR, a path search is performed on the first \fIarg\fR to determine the name of the script to execute. The script \fIarg\fR must have execute permission and any \fBsetuid\fR and \fBsetgid\fR settings are ignored. If the script is not found on the path, \fIarg\fR is processed as if it named a built-in command or function.
 .sp
 .LP
 Commands are then read as described, and the following options are interpreted by the shell when it is invoked:
 .sp
 .ne 2
 .LP
 These restrictions are enforced after .\fBprofile\fR and the \fBENV\fR files are interpreted.
 .sp
 .LP
 When a command to be executed is found to be a shell procedure, \fBrksh\fR invokes \fBksh\fR to execute it. Thus, it is possible to provide to the end-user shell procedures that have access to the full power of the standard shell, while imposing a limited menu of commands. This scheme assumes that the end-user does not have write and execute permissions in the same directory. The net effect of these rules is that the writer of the .\fBprofile\fR has complete control over user actions, by performing guaranteed setup actions and leaving the user in an appropriate directory (probably not the login directory). The system administrator often sets up a directory of commands, for example, \fB/usr/rbin\fR, that can be safely invoked by \fBrksh\fR.
-.SH USAGE
-.sp
-.LP
-See \fBlargefile\fR(5) for the description of the behavior of \fBksh\fR and \fBrksh\fR when encountering files greater than or equal to 2 Gbyte (2^31 bytes).
 .SH EXIT STATUS
 .sp
 .LP
 The following exit values are returned:
 .sp
 .LP
 The scripting interface is Uncommitted. The environment variables, \fB\&.paths\fR feature, and editing modes are Volatile.
 .SH SEE ALSO
 .sp
 .LP
-\fBcat\fR(1), \fBcd\fR(1), \fBchmod\fR(1), \fBcut\fR(1), \fBdate\fR(1), \fBegrep\fR(1), \fBecho\fR(1), \fBegrep\fR(1), \fBenv\fR(1), \fBfgrep\fR(1), \fBgrep\fR(1), \fBlogin\fR(1), \fBnewgrp\fR(1), \fBpaste\fR(1), \fBprintf\fR(1), \fBshell_builtins\fR(1), \fBstty\fR(1), \fBtest\fR(1), \fBumask\fR(1), \fBvi\fR(1), \fBdup\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBioctl\fR(2), \fBlseek\fR(2), \fBpathconf\fR(2), \fBpipe\fR(2), \fBsysconf\fR(3C), \fBulimit\fR(2), \fBumask\fR(2), \fBrand\fR(3C), \fBtcgetattr\fR(3C), \fBwait\fR(3C), \fBa.out\fR(4), \fBprofile\fR(4), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)
+\fBcat\fR(1), \fBcd\fR(1), \fBchmod\fR(1), \fBcut\fR(1), \fBdate\fR(1), \fBegrep\fR(1), \fBecho\fR(1), \fBegrep\fR(1), \fBenv\fR(1), \fBfgrep\fR(1), \fBgrep\fR(1), \fBlogin\fR(1), \fBnewgrp\fR(1), \fBpaste\fR(1), \fBprintf\fR(1), \fBshell_builtins\fR(1), \fBstty\fR(1), \fBtest\fR(1), \fBumask\fR(1), \fBvi\fR(1), \fBdup\fR(2), \fBexec\fR(2), \fBfork\fR(2), \fBioctl\fR(2), \fBlseek\fR(2), \fBpathconf\fR(2), \fBpipe\fR(2), \fBsysconf\fR(3C), \fBulimit\fR(2), \fBumask\fR(2), \fBrand\fR(3C), \fBtcgetattr\fR(3C), \fBwait\fR(3C), \fBa.out\fR(4), \fBprofile\fR(4), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
 .sp
 .LP
 Bolsky, Morris I. and Korn, David G., \fIThe New KornShell Command and Programming Language\fR, Prentice Hall, 1995.
 .sp
 .LP

changeset 3742	55497e208813
parent 953	a0fb7976f6c7