home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume24 / zsh2.1 / part03 < prev    next >
Text File  |  1991-10-24  |  50KB  |  1,653 lines

  1. Newsgroups: comp.sources.misc
  2. From: pfalstad@phoenix.Princeton.EDU (Paul Falstad)
  3. Subject:  v24i003:  zsh2.1 - The Z shell, Part03/19
  4. Message-ID: <1991Oct24.190735.25511@sparky.imd.sterling.com>
  5. X-Md4-Signature: 54965091ef6e91703d0a7d2f81a38a78
  6. Date: Thu, 24 Oct 1991 19:07:35 GMT
  7. Approved: kent@sparky.imd.sterling.com
  8.  
  9. Submitted-by: pfalstad@phoenix.Princeton.EDU (Paul Falstad)
  10. Posting-number: Volume 24, Issue 3
  11. Archive-name: zsh2.1/part03
  12. Environment: BSD
  13. Supersedes: zsh2.00: Volume 18, Issue 84-98
  14.  
  15. #!/bin/sh
  16. # this is zshar.03 (part 3 of zsh2.1.0)
  17. # do not concatenate these parts, unpack them in order with /bin/sh
  18. # file zsh2.1/man/man1/zsh.1 continued
  19. #
  20. if test ! -r _shar_seq_.tmp; then
  21.     echo 'Please unpack part 1 first!'
  22.     exit 1
  23. fi
  24. (read Scheck
  25.  if test "$Scheck" != 3; then
  26.     echo Please unpack part "$Scheck" next!
  27.     exit 1
  28.  else
  29.     exit 0
  30.  fi
  31. ) < _shar_seq_.tmp || exit 1
  32. if test ! -f _shar_wnt_.tmp; then
  33.     echo 'x - still skipping zsh2.1/man/man1/zsh.1'
  34. else
  35. echo 'x - continuing file zsh2.1/man/man1/zsh.1'
  36. sed 's/^X//' << 'SHAR_EOF' >> 'zsh2.1/man/man1/zsh.1' &&
  37. X.TP
  38. X\fBuniversal-argument\fP
  39. XMultiply the argument of the next command by 4.
  40. X.SS Completion
  41. X.TP
  42. X\fBaccept-and-menu-complete\fP
  43. XIn a menu completion, insert the current completion into the buffer,
  44. Xand advance to the next possible completion.
  45. X.TP
  46. X\fBcomplete-word\fP (unbound) (\|\e\|)
  47. XAttempt completion on the current word.
  48. X.TP
  49. X\fBdelete-char-or-list\fP (^D)
  50. XDelete the character under the cursor.  If the cursor
  51. Xis at the end of the line, list possible completions for the
  52. Xcurrent word.
  53. X.TP
  54. X\fBexecute-named-cmd\fP (ESC-x)
  55. XRead the name of a editor command and execute it.
  56. X.TP
  57. X\fBexecute-last-named-cmd\fP (ESC-z)
  58. XRedo the last function executed with \fBexecute-named-cmd\fP.
  59. X.TP
  60. X\fBexpand-cmd-path\fP
  61. XExpand the current command to its full pathname.
  62. X.TP
  63. X\fBexpand-or-complete\fP (TAB) (TAB ^X)
  64. XAttempt shell expansion on the current word.
  65. XIf that fails,
  66. Xattempt completion.
  67. X.TP
  68. X\fBexpand-history\fP (ESC-space ESC-!)
  69. XPerform history expansion on the edit buffer.
  70. X.TP
  71. X\fBexpand-word\fP (^X*)
  72. XAttempt shell expansion on the current word.
  73. X.TP
  74. X\fBlist-choices\fP (ESC-^D) (^D =)
  75. XList possible completions for the current word.
  76. X.TP
  77. X\fBlist-expand\fP (^Xg ^XG) (^G)
  78. XList the expansion of the current word.
  79. X.TP
  80. X\fBmagic-space\fP
  81. XPerform history expansion and insert a space into the
  82. Xbuffer.  This is intended to be bound to space.
  83. X.TP
  84. X\fBmenu-complete\fP
  85. XLike \fBcomplete-word\fP, except that menu completion is used.
  86. XSee the \fBMENU_COMPLETE\fP option below.
  87. X.TP
  88. X\fBmenu-expand-or-complete\fP
  89. XLike \fBexpand-or-complete\fP, except that menu completion is used.
  90. X.TP
  91. X\fBreverse-menu-complete\fP
  92. XSee the \fBMENU_COMPLETE\fP option below.
  93. X.SS Miscellaneous
  94. X.TP
  95. X\fBaccept-and-hold\fP (ESC-A ESC-a)
  96. XPush the contents of the buffer on the buffer stack
  97. Xand execute it.
  98. X.TP
  99. X\fBaccept-and-infer-next-history\fP
  100. XExecute the contents of the buffer.
  101. XThen search the history list for a line matching the current one
  102. Xand push the event following onto the buffer stack.
  103. X.TP
  104. X\fBaccept-line\fP (^J ^M)
  105. XExecute the contents of the buffer.
  106. X.TP
  107. X\fBaccept-line-and-down-history\fP (^O)
  108. XExecute the current line, and push the next history
  109. Xevent on the the buffer stack.
  110. X.TP
  111. X\fBvi-cmd-mode\fP (^X^V) (^[)
  112. XEnter command mode; that is, use the alternate keymap.
  113. XYes, this is bound by default in emacs mode.
  114. X.TP
  115. X\fBvi-caps-lock-panic\fP (unbound) (H K)
  116. XHang until any lowercase key is pressed.
  117. XThis is for vi users without the mental capacity to keep
  118. Xtrack of their caps lock key (like the author).
  119. X.TP
  120. X\fBclear-screen\fP (^L ESC-^L)
  121. XClear the screen and redraw the prompt.
  122. X.TP
  123. X\fBexchange-point-and-mark\fP (^X^X)
  124. XExchange the cursor position with the position of the mark.
  125. X.TP
  126. X\fBget-line\fP (ESC-G ESC-g)
  127. XPop the top line off the buffer stack and insert it at the
  128. Xcursor position.
  129. X.TP
  130. X\fBpush-line\fP (^Q ESC-Q ESC-q)
  131. XPush the current buffer onto the buffer stack and clear
  132. Xthe buffer.
  133. XNext time the editor starts up, the buffer will be popped
  134. Xoff the top of the buffer stack and loaded into the editing
  135. Xbuffer.
  136. X.TP
  137. X\fBredisplay\fP (unbound) (^R)
  138. XRedisplays the edit buffer.
  139. X.TP
  140. X\fBrun-help\fP (ESC-H ESC-h)
  141. XPush the buffer onto the buffer stack, and execute the
  142. Xcommand "\fBrun-help\fP \fIcmd\fP", where \fIcmd\fP is the current
  143. Xcommand.  \fBrun-help\fP is normally aliased to \fBman\fP.
  144. X.TP
  145. X\fBsend-break\fP (^C)
  146. XAbort the parsing of the current line.
  147. X.TP
  148. X\fBvi-set-buffer\fP (unbound) (")
  149. XSpecify a buffer to be used in the following command.
  150. X.TP
  151. X\fBvi-set-mark\fP (unbound) (m)
  152. XSet the specified mark at the cursor position.
  153. X.TP
  154. X\fBset-mark-command\fP (^@)
  155. XSet the mark at the cursor position.
  156. X.TP
  157. X\fBspell-word\fP (ESC-$ ESC-S ESC-s)
  158. XAttempt spelling correction on the current word.
  159. X.TP
  160. X\fBundefined-key\fP
  161. XBeep.
  162. X.TP
  163. X\fBundo\fP (^_ ^X^U) (u)
  164. XIncrementally undo the last text modification.
  165. X.TP
  166. X\fBwhich-command\fP (ESC-?)
  167. XPush the buffer onto the buffer stack, and execute the
  168. Xcommand "\fBwhich-command\fP \fIcmd\fP", where \fIcmd\fP is the current
  169. Xcommand.  \fBwhich-command\fP is normally aliased to \fBwhence\fP.
  170. X.SH PARAMETERS
  171. XA parameter has a name, a value, and a number of attributes.
  172. XA name may be any sequence of alphanumeric
  173. Xcharacters and _'s, or the single characters
  174. X*, @, #, ?, \-, $, or !.
  175. XThe value may be either a \fIscalar\fP (a string),
  176. Xan integer, or an array.
  177. XTo assign a scalar or integer value to a parameter,
  178. Xuse the \fBtypeset\fP builtin.
  179. XTo assign an array value, use \fBset \-A\fP \fIname\fP \fIvalue\fP ....
  180. XThe value of a parameter may also be assigned by writing:
  181. X.RS
  182. X.PP
  183. X\fIname\fP=\fIvalue\fP ...
  184. X.RE
  185. X.PP
  186. XIf the integer attribute, \-\fBi\fP, is set for \fIname\fP,
  187. Xthe \fIvalue\fP is subject to arithmetic evaluation.
  188. X.PP
  189. XThe value of an array parameter may be assigned by writing:
  190. X.RS
  191. X.PP
  192. X\fIname\fP=(\fIvalue\fP ...) ...
  193. X.RE
  194. XIndividual elements of an array may be selected using a 
  195. Xsubscript.  A subscript of the form \fB[\fIexp\fB]\fR
  196. Xselects the single element \fIexp\fP, where \fIexp\fP is
  197. Xan arithmetic expression.  The elements are numbered
  198. Xbeginning with 1.
  199. XA subscript of the form \fB[*]\fP or \fB[@]\fP evaluates to all
  200. Xelements of an array; there is no difference between the two
  201. Xexcept when they appear within double quotes.
  202. X"$foo[*]" evaluates to "$foo[1] $foo[2] ...", while
  203. X"$foo[@]" evaluates to "$foo[1]" "$foo[2]", etc.
  204. XA subscript of the form \fB[\fIexp1\fP,\fIexp2\fB]\fR
  205. Xselects all elements in the range \fIexp1\fP to \fIexp2\fP,
  206. Xinclusive.
  207. XIf one of the subscripts evaluates to a negative number,
  208. Xsay \-\fIn\fP, then the \fIn\fPth element from the end
  209. Xof the array is used.  Thus "$foo[-3]" is the third element
  210. Xfrom the end of the array \fIfoo\fP, and
  211. X"$foo[1,-1]" is the same as "$foo[*]".
  212. X.PP
  213. XSubscripting may also be performed on non-array values, in which
  214. Xcase the subscripts specify a substring to be extracted.
  215. XFor example, if \fBFOO\fP is set to \fBfoobar\fP, then
  216. X\fBecho $FOO[2,5]\fP prints \fBooba\fP.
  217. X.SS Positional Parameters
  218. XPositional parameters are set by the shell on invocation,
  219. Xby the \fBset\fP builtin, or by direct assignment.
  220. XThe parameter \fIn\fP, where \fIn\fP is a number,
  221. Xis the \fIn\fPth positional parameter.
  222. XThe parameters \fB*\fP, \fB@\fP, and \fBargv\fP are
  223. Xarrays containing all the positional parameters;
  224. Xthus \fBargv\fP[\fIn\fP], etc. is equivalent to simply \fIn\fP.
  225. X.SS Special Parameters
  226. XThe following parameters are automatically set by the shell:
  227. X.PP
  228. X.RS
  229. X.PD 0
  230. X.TP
  231. X.B !
  232. XThe process id of the last background command invoked.
  233. X.TP
  234. X.B #
  235. XThe number of positional parameters in decimal.
  236. X.TP
  237. X.B ARGC
  238. XSame as \fB#\fP.
  239. X.TP
  240. X.B $
  241. XThe process id of this shell.
  242. X.TP
  243. X.B \-
  244. XFlags supplied to the shell on invocation or by the \fBset\fP
  245. Xor \fBsetopt\fP commands.
  246. X.TP
  247. X.B *
  248. XAn array containing the positional parameters.
  249. X.TP
  250. X.B argv
  251. XSame as \fB*\fP.
  252. X.TP
  253. X.B @
  254. XSame as \fBargv[@]\fP.
  255. X.TP
  256. X.B ?
  257. XThe exit value returned by the last command.
  258. X.TP
  259. X.B status
  260. XSame as \fB?\fP.
  261. X.TP
  262. X.B _
  263. XThe last argument of the previous command.
  264. XAlso, this parameter is set in the environment of every command
  265. Xexecuted to the full pathname of the command.
  266. X.TP
  267. X.B ERRNO
  268. XThe value of errno as set by the most recently failed system call.
  269. XThis value is system dependent and is intended for debugging
  270. Xpurposes.
  271. X.TP
  272. X.B GID
  273. XThe group id of the shell process.
  274. X.TP
  275. X.B HOST
  276. XThe current hostname.
  277. X.TP
  278. X.B HOSTTYPE
  279. XA string corresponding to the type of the host the shell
  280. Xis running on.
  281. X.TP
  282. X.B LINENO
  283. XThe line number of the current line within the current script
  284. Xbeing executed.
  285. X.TP
  286. X.B OLDPWD
  287. XThe previous working directory.
  288. X.TP
  289. X.B OPTARG
  290. XThe value of the last option argument processed by the \fBgetopts\fP
  291. Xcommand.
  292. X.TP
  293. X.B OPTIND
  294. XThe index of the last option argument processed by the \fBgetopts\fP
  295. Xcommand.
  296. X.TP
  297. X.B PPID
  298. XThe process id of the parent of the shell.
  299. X.TP
  300. X.B PWD
  301. XThe present working directory.
  302. X.TP
  303. X.B RANDOM
  304. XA random integer from 0 to 32767, newly generated each time
  305. Xthis parameter is referenced.  The random number generator
  306. Xcan be seeded by assigning a numeric value to \fBRANDOM\fP.
  307. X.TP
  308. X.B SECONDS
  309. XThe number of seconds since shell invocation.  If this parameter
  310. Xis assigned a value, then the value returned upon reference
  311. Xwill be the value that was assigned plus the number of seconds
  312. Xsince the assignment.
  313. X.TP
  314. X.B SHLVL
  315. XIncremented by one each time a new shell is started.
  316. X.TP
  317. X.B signals
  318. XAn array containing the names of the signals.
  319. X.TP
  320. X.B TTY
  321. XThe name of the tty associated with the shell, if any.
  322. X.TP
  323. X.B UID
  324. XThe user id of the shell process.
  325. X.TP
  326. X.B USERNAME
  327. X.TP
  328. X.B LOGNAME
  329. XThe username corresponding to the user id of the shell process.
  330. X.TP
  331. X.B VERSION
  332. XThe version number of this \fBzsh\fP.
  333. X.PD
  334. X.RE
  335. X.PP
  336. XThe following parameters are used by the shell:
  337. X.PP
  338. X.RS
  339. X.PD 0
  340. X.TP
  341. X.B BAUD
  342. XThe baud rate of the current connection.  Used by the line editor
  343. Xupdate mechanism to compensate for a slow terminal by delaying
  344. Xupdates until necessary.  This may be profitably set to a lower value
  345. Xin some circumstances, e.g.
  346. Xfor slow modems dialing into a communications server which is connected
  347. Xto a host via a fast link; in this case, this variable
  348. Xwould be set by default to the speed of the fast link, and not
  349. Xthe modem.
  350. XThis parameter should be set to the baud
  351. Xrate of the slowest part of the link for best performance.
  352. X.TP
  353. X.B bindcmds (BINDCMDS)
  354. XAn array (colon-separated list)
  355. Xof command names which take line editor function names
  356. Xas arguments, and which therefore should allow binding
  357. Xcompletion.
  358. X.TP
  359. X.B cdpath (CDPATH)
  360. XAn array (colon-separated list)
  361. Xof directories specifying the search path for the \fBcd\fP command.
  362. X.TP
  363. X.B COLUMNS
  364. XThe number of columns for this terminal session.
  365. XUsed for printing select lists and for the line editor.
  366. X.TP
  367. X.B DIRSTACKSIZE
  368. XThe maximum size of the directory stack.  If the 
  369. Xstack gets larger than this, it will be truncated automatically.
  370. XThis is useful with the \fBAUTO_PUSHD\fP option.
  371. X.TP
  372. X.B FCEDIT
  373. XThe default editor for the \fBfc\fP builtin.
  374. X.TP
  375. X.B fignore (FIGNORE)
  376. XAn array (colon separated list)
  377. Xcontaining the suffixes of files to be ignored
  378. Xduring filename completion.
  379. X.TP
  380. X.B fpath (FPATH)
  381. XAn array (colon separated list)
  382. Xof directories specifying the search path for
  383. Xfunction definitions.  This path is searched when a function
  384. Xwith the \-\fBu\fP attribute is referenced.  If an executable
  385. Xfile is found, then it is read and executed in the current environment.
  386. X.TP
  387. X.B HISTCHARS
  388. XThree characters used by the shell's history and lexical analysis
  389. Xmechanism.  The first character signals the start of a history
  390. Xsubstitution (default `!').  The second character signals the
  391. Xstart of a quick history substitution (default `^').  The third
  392. Xcharacter is the comment character (default `#').
  393. X.TP
  394. X.B HISTFILE
  395. XThe file to save the history in when an interactive shell exits.
  396. XIf unset, the history is not saved.
  397. X.TP
  398. X.B HISTSIZE
  399. XThe maximum size of the history list.
  400. X.TP
  401. X.B HOME
  402. XThe default argument for the \fBcd\fP command.
  403. X.TP
  404. X.B hostcmds (HOSTCMDS)
  405. XAn array (colon separated list) of command names which
  406. Xtake hostnames as arguments, and which should therefore
  407. Xallow hostname completion.  This sort of completion is also
  408. Xused in words containing a \fB@\fP character.
  409. X.TP
  410. X.B hosts (HOSTS)
  411. XAn array (colon separated list) of hostnames to use
  412. Xfor hostname completion.
  413. X.TP
  414. X.B IFS
  415. XInternal field separators, normally space, tab, and newline, that
  416. Xare used to separate command words, words which result from
  417. Xcommand or parameter substitution, and words read by
  418. Xthe \fBread\fP builtin.
  419. X.TP
  420. X.B LINES
  421. XThe number of lines for this terminal session.
  422. XUsed for printing select lists and for the line editor.
  423. X.TP
  424. X.B LISTMAX
  425. XIn the line editor,
  426. Xthe number of filenames to list without asking first.
  427. X.TP
  428. X.B LITHISTSIZE
  429. XThe maximum size of the literal history list (before history expansion).
  430. X.TP
  431. X.B LOGCHECK
  432. XThe interval in seconds between checks for login/logout activity
  433. Xusing the \fBwatch\fP parameter.
  434. X.TP
  435. X.B MAIL
  436. XIf this parameter is set and \fBmailpath\fP is not set,
  437. Xthe shell looks for mail in the specified file.
  438. X.TP
  439. X.B MAILCHECK
  440. XThe interval in seconds between checks for new mail. 
  441. X.TP
  442. X.B mailpath (MAILPATH)
  443. XAn array (colon-separated list)
  444. Xof filenames to check for new mail.  Each filename can
  445. Xbe followed by a ? and a message that will be printed.
  446. XThe sequence $_ in the message will be replaced by the name 
  447. Xof the mail file.
  448. XThe default message is "You have new mail."
  449. X.TP
  450. X.B NULLCMD
  451. XThe command name to assume if a redirection is specified
  452. Xwith no command.  Defaults to \fBcat\fP.  For sh/ksh-like
  453. Xbehavior, change this to \fB:\fP.  For csh-like
  454. Xbehavior, unset this parameter; the shell will print an
  455. Xerror message if null commands are entered.
  456. X.TP
  457. X.B optcmds (OPTCMDS)
  458. XAn array (colon-separated list) of
  459. Xcommands which take options as arguments, and which
  460. Xtherefore should allow option completion.
  461. X.TP
  462. X.B path (PATH)
  463. XAn array (colon-separated list)
  464. Xof directories to search for commands.
  465. XWhen this parameter is set, each directory is scanned
  466. Xand all files found are put in a hash table.
  467. XIf a component of \fBpath\fP begins with the string "\fB/.\fP",
  468. Xe.g. "\fB/./usr/etc\fP", then that directory is not prescanned.
  469. XThis is useful for directories like /usr/etc which contain
  470. Xonly occasionally-used commands.
  471. X.TP
  472. X.B PROMPT
  473. XThe primary prompt string, printed before a command is read;
  474. Xthe default is "%m%# ".
  475. XThe following escape sequences are recognized:
  476. X.PD
  477. X.PP
  478. X.PD 0
  479. X.RS
  480. X.TP
  481. X.B %d %/
  482. XPresent working directory ($PWD).
  483. X.TP
  484. X.B %~
  485. X$PWD.
  486. XIf it has a named directory as its prefix, that part is replaced
  487. Xby a ~ followed by the name of the directory.
  488. XIf it starts with $HOME, that part is
  489. Xreplaced by a ~.
  490. X.TP
  491. X.B %c %. %C
  492. XTrailing component of $PWD.
  493. XMay be followed by a digit to get more than one component.
  494. XUnless \fB%C\fP is used, tilde expansion is performed first.
  495. X.TP
  496. X.B ! %h %!
  497. XCurrent history event number
  498. X.TP
  499. X.B %M
  500. XThe full machine hostname.
  501. X.TP
  502. X.B %m
  503. XThe hostname up to the first '.'.
  504. XMay be followed by a digit to specify
  505. Xhow many components of the hostname are desired.
  506. X.TP
  507. X.B %S (%s)
  508. XStart (stop) standout mode.
  509. X.TP
  510. X.B %U (%u)
  511. XStart (stop) underline mode.
  512. X.TP
  513. X.B %B (%b)
  514. XStart (stop) boldface mode.
  515. X.TP
  516. X.B %t
  517. X.TP
  518. X.B %@
  519. XCurrent time of day, in 12-hour, am/pm format.
  520. X.TP
  521. X.B %T
  522. XCurrent time of day, in 24-hour format.
  523. X.TP
  524. X.B %*
  525. XCurrent time of day in 24-hour format, with seconds.
  526. X.TP
  527. X.B %n
  528. X\fB$USERNAME\fP.
  529. X.TP
  530. X.B %w
  531. XThe date in day\-dd format.
  532. X.TP
  533. X.B %W
  534. XThe date in mm/dd/yy format.
  535. X.TP
  536. X.B %D
  537. XThe date in yy\-mm\-dd format.
  538. X.TP
  539. X.B %l
  540. XThe line (tty) the user is logged in on.
  541. X.TP
  542. X.B %?
  543. XThe return code of the last command executed just before the prompt.
  544. X.TP
  545. X.B %#
  546. XA '#' if the shell is running as root, a '%' if not.
  547. X.TP
  548. X\fB%{\fP...\fB%}\fP
  549. XInclude a string as a literal escape sequence.
  550. XThe string within the braces should not change the cursor
  551. Xposition.
  552. X.RE
  553. X.PD
  554. X.PP
  555. X.PD 0
  556. X.TP
  557. X.B PROMPT2
  558. XThe secondary prompt, printed when the shell needs more information
  559. Xto complete a command.
  560. XRecognizes the same escape sequences as \fB$PROMPT\fP.
  561. XThe default is "> ".
  562. X.TP
  563. X.B PROMPT3
  564. XSelection prompt used within a \fBselect\fP loop.
  565. XRecognizes the same escape sequences as \fB$PROMPT\fP.
  566. XThe default is "?# ".
  567. X.TP
  568. X.B PROMPT4
  569. XThe execution trace prompt.  Default is "+ ".
  570. X.TP
  571. X.B PS1
  572. X.TP
  573. X.B PS2
  574. X.TP
  575. X.B PS3
  576. X.TP
  577. X.B PS4
  578. XSame as \fBPROMPT\fP, \fBPROMPT2\fP, \fBPROMPT3\fP, and \fBPROMPT4\fP,
  579. Xrespectively.
  580. X.TP
  581. X.B prompt
  582. XSame as \fBPROMPT\fP.
  583. X.TP
  584. X.B RPROMPT
  585. X.TP
  586. X.B RPS1
  587. XThis prompt is displayed on the right-hand side of the screen
  588. Xwhen the primary prompt is being displayed on the left.
  589. XThis does not work if the \fBSINGLELINEZLE\fP option is set.
  590. XRecognizes the same escape sequences as \fBPROMPT\fP,
  591. Xexcept that termcap sequences like \fB%s\fP, etc. will not work.
  592. X.TP
  593. X.B SAVEHIST
  594. XThe maximum number of history events to save in the history file.
  595. X.TP
  596. X.B SPROMPT
  597. XThe prompt used for spelling correction.  The sequence
  598. X\fB%s\fP expands to the string which presumably needs spelling
  599. Xcorrection, and \fB%r\fP expands to the proposed correction.
  600. X.TP
  601. X.B STTY
  602. XIf this parameter is set in a command's environment, the shell
  603. Xruns the \fBstty\fP command with the value of this parameter as arguments
  604. Xin order to set up the terminal before executing the command.
  605. X.TP
  606. X.B TIMEFMT
  607. XThe format of process time reports with the \fBtime\fP keyword.
  608. XThe default is "%E real  %U user  %S system  %P".
  609. XRecognizes the following escape sequences:
  610. X.PD
  611. X.PP
  612. X.PD 0
  613. X.RS
  614. X.TP
  615. X.B %U
  616. XCPU seconds spent in user mode.
  617. X.TP
  618. X.B %S
  619. XCPU seconds spent in kernel mode.
  620. X.TP
  621. X.B %E
  622. XElapsed time in seconds.
  623. X.TP
  624. X.B %P
  625. XThe CPU percentage, computed as (%U+%S)/%E.
  626. X.TP
  627. X.B %W
  628. XNumber of times the process was swapped.
  629. X.TP
  630. X.B %X
  631. XThe average amount in (shared) text space used in Kbytes.
  632. X.TP
  633. X.B %D
  634. XThe average amount in (unshared) data/stack space used in Kbytes.
  635. X.TP
  636. X.B %K
  637. XThe total space used (%X+%D) in Kbytes.
  638. X.TP
  639. X.B %M
  640. XThe maximum memory the process had in use at any time in Kbytes.
  641. X.TP
  642. X.B %F
  643. XThe number of major page faults (page needed to be brought from disk).
  644. X.TP
  645. X.B %R
  646. XThe number of minor page faults.
  647. X.TP
  648. X.B %I
  649. XThe number of input operations.
  650. X.TP
  651. X.B %O
  652. XThe number of output operations.
  653. X.TP
  654. X.B %r
  655. XThe number of socket messages received.
  656. X.TP
  657. X.B %s
  658. XThe number of socket messages sent.
  659. X.TP
  660. X.B %k
  661. XThe number of signals received.
  662. X.TP
  663. X.B %w
  664. XNumber of voluntary context switches (waits).
  665. X.TP
  666. X.B %c
  667. XNumber of involuntary context switches.
  668. X.RE
  669. X.PD
  670. X.PP
  671. X.PD 0
  672. X.TP
  673. X.B TMOUT
  674. XIf this parameter is nonzero, the shell will terminate if a command is not
  675. Xentered within the specified number of seconds after issuing
  676. Xa prompt.
  677. X.TP
  678. X.B TMPPREFIX
  679. XA pathname prefix which the shell will use for all temporary files.
  680. X.TP
  681. X.B varcmds (VARCMDS)
  682. XAn array (colon-separated list)
  683. Xof command names which take parameter names
  684. Xas arguments, and which therefore should allow parameter
  685. Xcompletion.
  686. X.TP
  687. X.B watch (WATCH)
  688. XAn array (colon-separated list) of login/logout events to report.
  689. XIf it contains the single word "all", then all login/logout events
  690. Xare reported.
  691. XAn entry in this list may consist of a username,
  692. Xan `@' followed by a remote hostname,
  693. Xand a `%' followed by a line (tty).
  694. XAny or all of these components may be present in an entry;
  695. Xif a login/logout event matches all of them,
  696. Xit is reported.
  697. X.TP
  698. X.B WATCHFMT
  699. XThe format of login/logout reports if the \fBwatch\fP parameter is set.
  700. XDefault is "%n has %a %l from %m."
  701. XRecognizes the following escape sequences:
  702. X.PD
  703. X.PP
  704. X.PD 0
  705. X.RS
  706. X.TP
  707. X.B %n
  708. XThe name of the user that logged in/out.
  709. X.TP
  710. X.B %a
  711. XThe observed action, i.e. "logged on" or "logged off".
  712. X.TP
  713. X.B %l
  714. XThe line (tty) the user is logged in on.
  715. X.TP
  716. X.B %M
  717. XThe full hostname of the remote host.
  718. X.TP
  719. X.B %m
  720. XThe hostname up to the first ".".  If only the
  721. Xip address is available or the utmp field contains
  722. Xthe name of an X-windows display, the whole name is printed.
  723. X.TP
  724. X.B %S (%s)
  725. XStart (stop) standout mode.
  726. X.TP
  727. X.B %U (%u)
  728. XStart (stop) underline mode.
  729. X.TP
  730. X.B %B (%b)
  731. XStart (stop) boldface mode.
  732. X.TP
  733. X.B %t
  734. X.TP
  735. X.B %@
  736. XThe time, in 12-hour, am/pm format.
  737. X.TP
  738. X.B %T
  739. XThe time, in 24-hour format.
  740. X.TP
  741. X.B %w
  742. XThe date in day\-dd format.
  743. X.TP
  744. X.B %W
  745. XThe date in mm/dd/yy format.
  746. X.TP
  747. X.B %D
  748. XThe date in yy\-mm\-dd format.
  749. X.RE
  750. X.PD
  751. X.PP
  752. X.PD 0
  753. X.TP
  754. X.B WORDCHARS
  755. XA list of nonalphanumeric characters considered part of a word
  756. Xby the line editor.
  757. X.TP
  758. X.B ZDOTDIR
  759. XThe directory to search for shell startup files (.zshrc, etc),
  760. Xif not \fB$HOME\fP.
  761. X.PD
  762. X.RE
  763. X.PP
  764. X.SH OPTIONS
  765. XThe following options may be set upon invocation of the shell,
  766. Xor with the \fBset\fP or \fBsetopt\fP builtins:
  767. X.RS
  768. X.PD 0
  769. X.TP
  770. X\fBALLEXPORT\fP (\-\fBa\fP)
  771. XAll parameters subsequently defined are automatically exported.
  772. X.TP
  773. X\fBAUTO_CD\fP (\-\fBJ\fP)
  774. XIf a command is not in the hash table, and there exists an
  775. Xexecutable directory by that name, perform the \fBcd\fP
  776. Xcommand to that directory.
  777. X.TP
  778. X\fBAUTOLIST\fP (\-\fB9\fP)
  779. XAutomatically list choices on an ambiguous completion.
  780. X.TP
  781. X\fBAUTOMENU\fP
  782. XAutomatically use menu completion if the \fPTAB\fP
  783. Xkey is pressed repeatedly.
  784. X.TP
  785. X\fBAUTO_PUSHD\fP (\-\fBN\fP)
  786. XMake \fBcd\fP act like \fBpushd\fP.
  787. X.TP
  788. X\fBAUTO_RESUME\fP (\-\fBW\fP)
  789. XTreat single word simple commands without redirection
  790. Xas candidates for resumption of an existing job.
  791. X.TP
  792. X\fBBGNICE\fP (\-\fB6\fP)
  793. XRun all background jobs at a lower priority.  This option
  794. Xis set by default.
  795. X.TP
  796. X\fBCDABLEVARS\fP (\-\fBT\fP)
  797. XIf the argument to a \fBcd\fP command is not a directory,
  798. Xbut a parameter exists by the same name whose value
  799. Xbegins with a /, try to change to the directory
  800. Xspecified by the parameter's value.
  801. X.TP
  802. X\fBCHASELINKS\fP (\-\fBw\fP)
  803. XResolve symbolic links to their true values.
  804. X.TP
  805. X\fBCORRECT\fP (\-\fB0\fP)
  806. XTry to correct the spelling of commands.
  807. X.TP
  808. X\fBCORRECT_ALL\fP (\-\fBO\fP)
  809. XTry to correct the spelling of all arguments in a line.
  810. X.TP
  811. X\fBCSH_JUNKIE_LOOPS\fP
  812. XAllow loop bodies to take the form
  813. X"\fIlist\fP; \fBend\fP" instead of
  814. X"\fBdo\fP \fIlist\fP; \fBdone\fP".
  815. X.TP
  816. X\fBCSH_JUNKIE_QUOTES\fP
  817. XComplain if a quoted expression runs off the end of a line;
  818. Xprevent quoted expressions from containing unescaped newlines.
  819. X.TP
  820. X\fBCSH_NULL_GLOB\fP
  821. XIf a pattern for filename generation has no matches,
  822. Xdelete the pattern from the argument list;
  823. Xdo not report an error unless all the patterns
  824. Xin a command have no matches.
  825. XOverrides \fBNULLGLOB\fP.
  826. X.TP
  827. X\fBERREXIT\fP (\-\fBe\fP)
  828. XIf a command has a non-zero exit status, execute the \fBERR\fP
  829. Xtrap, if set, and exit.
  830. X.TP
  831. X\fBEXTENDED_GLOB\fP
  832. XTreat the # and ^ characters as part of patterns for filename
  833. Xgeneration, etc.
  834. X.TP
  835. X\fBGLOB_COMPLETE\fP
  836. XLike \fBMENU_COMPLETE\fP, except that the current word
  837. Xis expanded using normal shell expansion instead of completion.
  838. XIf no matches are found, a * is added to the end of the word, and expansion
  839. Xis attempted again.
  840. X.TP
  841. X\fBGLOB_DOTS\fP (\-\fB4\fP)
  842. XDo not require a leading . in a filename to be matched explicitly.
  843. X.TP
  844. X\fBHIST_IGNORE_DUPS\fP (\-\fBh\fP)
  845. XDo not enter command lines into the history list
  846. Xif they are duplicates of the previous event.
  847. X.TP
  848. X\fBHIST_IGNORE_SPACE\fP (\-\fBg\fP)
  849. XDo not enter command lines into the history list
  850. Xif they begin with a blank.
  851. X.TP
  852. X\fBHISTLIT\fP (\-\fBj\fP)
  853. XUse literal (unparsed) versions of the history lines
  854. Xin the editor.
  855. X.TP
  856. X\fBHIST_NO_STORE\fP
  857. XRemove the \fBhistory\fP (\fBfc\fP \-\fBl\fP) command from
  858. Xthe history when invoked.
  859. X.TP
  860. X\fBHIST_VERIFY\fP
  861. XWhenever the user enters a line with history substitution,
  862. Xdon't execute the line directly; instead, perform
  863. Xhistory substitution and reload the line into the editing buffer.
  864. X.TP
  865. X\fBIGNORE_BRACES\fP (\-\fBI\fP)
  866. XDo not perform brace expansion.
  867. X.TP
  868. X\fBIGNOREEOF\fP (\-\fB7\fP)
  869. XDo not exit on end-of-file.  Require the use
  870. Xof \fBexit\fP or \fBlogout\fP instead.
  871. X.TP
  872. X\fBINTERACTIVE\fP (\-\fBi\fP)
  873. XThis is an interactive shell.
  874. X.TP
  875. X\fBINTERACTIVE_COMMENTS\fP (\-\fBk\fP)
  876. XAllow comments even in interactive shells.
  877. X.TP
  878. X\fBKSH_OPTION_PRINT\fP
  879. XAlters the way options settings are printed.
  880. X.TP
  881. X\fBLIST_TYPES\fP (\-\fBX\fP)
  882. XWhen listing files that are possible completions, show the
  883. Xtype of each file with a trailing identifying mark.
  884. X.TP
  885. X\fBLOGIN\fP (\-\fBl\fP)
  886. XThis is a login shell.
  887. X.TP
  888. X\fBLONG_LIST_JOBS\fP (\-\fBR\fP)
  889. XList jobs in the long format by default.
  890. X.TP
  891. X\fBMAIL_WARNING\fP (\-\fBU\fP)
  892. XPrint a warning message if a mail file has been
  893. Xaccessed since the shell last checked.
  894. X.TP
  895. X\fBMARKDIRS\fP (\-\fB8\fP)
  896. XAppend a trailing / to all directory
  897. Xnames resulting from filename generation (globbing).
  898. X.TP
  899. X\fBMENU_COMPLETE\fP (\-\fBY\fP)
  900. XOn an ambiguous completion, instead of listing possibilities,
  901. Xinsert the first match.  Then when completion is requested
  902. Xagain, remove the first match and insert the second match, etc.
  903. XWhen there are no more matches, go back to the first one again.
  904. X\fBreverse-menu-complete\fP may be used to loop through the list
  905. Xin the other direction.
  906. X.TP
  907. X\fBMENU_COMPLETE_BEEP\fP
  908. XBeep on an ambiguous menu completion.
  909. X.TP
  910. X\fBMONITOR\fP (\-\fBm\fP)
  911. XAllow job control.  Set by default in interactive shells.
  912. X.TP
  913. X\fBNO_BAD_PATTERN\fP (\-\fB2\fP)
  914. XIf a pattern for filename generation is badly formed,
  915. Xleave it unchanged in the argument list instead of
  916. Xprinting an error.
  917. X.TP
  918. X\fBNO_BANG_HIST\fP (\-\fBK\fP)
  919. XDo not perform textual history substitution.  Do not
  920. Xtreat the ! character specially.
  921. X.TP
  922. X\fBNOBEEP\fP (\-\fBB\fP)
  923. XDo not beep.
  924. X.TP
  925. X\fBNO_CLOBBER\fP (\-\fB1\fP)
  926. XPrevents \fB>\fP redirection from truncating existing files.
  927. X\fB>!\fP may be used to truncate a file instead.
  928. XAlso prevents \fB>>\fP from creating files.
  929. X\fB>>!\fP may be used instead.
  930. X.TP
  931. X\fBNO_EQUALS\fP
  932. XDon't perform \fB=\fP filename substitution.
  933. X.TP
  934. X\fBNOEXEC\fP (\-\fBn\fP)
  935. XRead commands and check them for syntax errors, but do not execute them.
  936. X.TP
  937. X\fBNOGLOB\fP (\-\fBF\fP)
  938. XDisable filename generation.
  939. X.TP
  940. X\fBNOHUP\fP
  941. XDon't send the \fBHUP\fP signal to running jobs when the
  942. Xshell exits.
  943. X.TP
  944. X\fBNO_LIST_BEEP\fP
  945. XDon't beep on an ambiguous completion.
  946. X.TP
  947. X\fBNO_NOMATCH\fP (\-\fB3\fP)
  948. XIf a pattern for filename generation has no matches,
  949. Xleave it unchanged in the argument list instead of
  950. Xprinting an error.
  951. X.TP
  952. X\fBNO_PROMPT_CLOBBER\fP (\-\fBV\fP)
  953. XDon't print a carriage return just before printing
  954. Xa prompt in the line editor.
  955. X.TP
  956. X\fBNO_RCS\fP (\-\fBf\fP)
  957. XDo not source the .zshenv, .zshrc, .zlogin, .zlogout, or .zprofile files.
  958. X.TP
  959. X\fBNO_SHORT_LOOPS\fP
  960. XDisallow the short forms of \fBfor\fP, \fBselect\fP,
  961. X\fBif\fP, and \fBfunction\fP constructs.
  962. X.TP
  963. X\fBNOTIFY\fP (\-\fB5\fP)
  964. XReport the status of background jobs immediately, rather than
  965. Xwaiting until just before printing a prompt.
  966. X.TP
  967. X\fBNOUNSET\fP (\-\fBu\fP)
  968. XTreat unset parameters as an error when substituting.
  969. X.TP
  970. X\fBNULLGLOB\fP (\-\fBG\fP)
  971. XIf a pattern for filename generation has no matches,
  972. Xdelete the pattern from the argument list instead
  973. Xof reporting an error.  Overrides \fBNONOMATCH\fP.
  974. X.TP
  975. X\fBPATH_DIRS\fP (\-\fBQ\fP)
  976. XPerform a path search even on command names with slashes in them.
  977. XThus if "/usr/local/bin" is in the user's path, and he types
  978. X"X11/xinit", the command "/usr/local/bin/X11/xinit" will be executed
  979. X(assuming it exists).
  980. X.TP
  981. X\fBPRINT_EXIT_VALUE\fP (\-\fBC\fP)
  982. XPrint the exit value of programs with non-zero exit status.
  983. X.TP
  984. X\fBPUSHD_MINUS\fP
  985. XSee \fBpopd\fP below.
  986. X.TP
  987. X\fBPUSHD_SILENT\fP (\-\fBE\fP)
  988. XDo not print the directory stack after \fBpushd\fP
  989. Xor \fBpopd\fP.
  990. X.TP
  991. X\fBPUSHD_TO_HOME\fP (\-\fBD\fP)
  992. XHave \fBpushd\fP with no arguments act like
  993. X\fBpushd\fP $HOME.
  994. X.TP
  995. X\fBRC_EXPAND_PARAM\fP (\-\fBP\fP)
  996. XSee \fIParameter Expansion\fP.
  997. X.TP
  998. X\fBRC_QUOTES\fP
  999. XAllow the character sequence \fB''\fP to signify a single quote
  1000. Xwithin singly quoted strings.
  1001. X.TP
  1002. X\fBRECEXACT\fP (\-\fBS\fP)
  1003. XIn completion, recognize exact matches even
  1004. Xif they are ambiguous.
  1005. X.TP
  1006. X\fBRMSTARSILENT\fP (\-\fBH\fP)
  1007. XDo not query the user before executing "rm *".
  1008. X.TP
  1009. X\fBSHINSTDIN\fP (\-\fBs\fP)
  1010. XRead commands from the standard input.
  1011. X.TP
  1012. X\fBSH_WORD_SPLIT\fP (\-\fBy\fP)
  1013. XSee \fIParameter Expansion\fP.
  1014. X.TP
  1015. X\fBSINGLE_LINE_ZLE\fP (\-\fBM\fP)
  1016. XUse single-line command line editing instead of multi-line.
  1017. X.TP
  1018. X\fBSUN_KEYBOARD_HACK\fP (\-\fBL\fP)
  1019. XIf a line ends with a backquote, and there are an odd number
  1020. Xof backquotes on the line, ignore the trailing backquote.
  1021. XThis is useful on some keyboards where the return key is
  1022. Xtoo small, and the backquote key lies annoyingly close to it.
  1023. X.TP
  1024. X\fBVERBOSE\fP (\-\fBv\fP)
  1025. XPrint shell input lines as they are read.
  1026. X.TP
  1027. X\fBXTRACE\fP (\-\fBx\fP)
  1028. XPrint commands and their arguments as they are executed.
  1029. X.TP
  1030. X\fBZLE\fP (\-\fBZ\fP)
  1031. XUse the zsh line editor.
  1032. X.RE
  1033. X.PD
  1034. X.SH "SHELL BUILTIN COMMANDS"
  1035. X.TP
  1036. X\fB\&.\fP \fIfile\fP [ \fIarg\fP ... ]
  1037. XRead and execute commands from \fIfile\fP in the current shell
  1038. Xenvironment.
  1039. XIf \fIfile\fP does not contain a slash, the shell
  1040. Xlooks in the components of \fBpath\fP to find the directory
  1041. Xcontaining \fIfile\fP.
  1042. XIf any arguments \fIarg\fP are given,
  1043. Xthey become the positional parameters; the old positional
  1044. Xparameters are restored when the \fIfile\fP is done executing.
  1045. XThe exit status is the exit status of the last command executed.
  1046. X.TP
  1047. X\fB:\fP [ \fIarg\fP ... ]
  1048. XThis command only expands parameters.  A zero exit code is returned.
  1049. X.TP
  1050. X\fBalias\fP [ \-\fBg\fP ] [ \fIname\fP[=\fIvalue\fP] ] ...
  1051. XWith no arguments, print the list of aliases in the form
  1052. X\fIname\fP=\fBvalue\fP on the standard output.
  1053. XFor each \fIname\fP with a corresponding \fIvalue\fP, define an alias 
  1054. Xwith that value.
  1055. XA trailing space in \fIvalue\fP causes the next
  1056. Xword to be checked for alias substitution.
  1057. XIf the \-\fBg\fP flag is present, define a global alias; global aliases
  1058. Xare expanded even if they do not occur in command position.
  1059. XFor each \fIname\fP with no \fIvalue\fP, print the value of \fIname\fP,
  1060. Xif any.
  1061. XThe exit status is nonzero if a \fIname\fP (with no \fIvalue\fP)
  1062. Xgiven for which no alias has been defined.
  1063. X.TP
  1064. X\fBautoload\fP [ \fIname\fP ... ]
  1065. XFor each of the \fIname\fPs (which are names of functions),
  1066. Xcreate a function marked undefined.
  1067. XThe \fBfpath\fP variable will be searched to find the
  1068. Xactual function definition when the function is first referenced.
  1069. X.TP
  1070. X.PD 0
  1071. X\fBbg\fP [ \fIjob\fP ... ]
  1072. X.TP
  1073. X\fIjob\fP ... \fB&\fP
  1074. X.PD
  1075. XPut each specified \fIjob\fP in the background,
  1076. Xor the current job if none is specified.
  1077. X.TP
  1078. X.PD 0
  1079. X\fBbindkey\fP \-\fBmevd
  1080. X.TP
  1081. X\fBbindkey\fP \-\fBr\fP \fIin-string\fP ...
  1082. X.TP
  1083. X\fBbindkey\fP [ \-\fBa\fP ] \fIin-string\fP [ \fIcommand\fP ] ...
  1084. X.TP
  1085. X\fBbindkey\fP \-\fBs\fP [ \-\fBa\fP ] \fIin-string\fP \fIout-string\fP ...
  1086. X.PD
  1087. XIf one of the \-\fBe\fP, \-\fBv\fP, or \-\fBd\fP options is given,
  1088. Xreset the keymaps for emacs mode, vi mode, or the default mode,
  1089. Xrespectively; if the \-\fBm\fP option is also given,
  1090. Xallow the use of a meta key.
  1091. XIf the \-\fBr\fP option is given, remove any binding for each \fIin-string\fP.
  1092. XIf the \-\fBs\fP option is not specified, bind each \fIin-string\fP
  1093. Xto a specified \fIcommand\fP.  If no \fIcommand\fP is specified,
  1094. Xprint the binding of \fIin-string\fP if it is bound, or return
  1095. Xa nonzero exit code if it is not bound.
  1096. XIf the \-\fBs\fP option is specified, bind each \fIin-string\fP
  1097. Xto each specified \fIout-string\fP.  When \fIin-string\fP is typed,
  1098. X\fIout-string\fP will be pushed back and treated as input to the
  1099. Xline editor.
  1100. XIf the \-\fBa\fP option is specified, bind the \fIin-string\fPs in the
  1101. Xalternative keymap instead of the standard one.  The alternative
  1102. Xkeymap is used in vi command mode.
  1103. X.RS
  1104. X.PP
  1105. XFor either \fIin-string\fP or \fIout-string\fP, control characters
  1106. Xmay be specified in the form \fB^X\fP, and the backslash may
  1107. Xbe used to introduce one of the following escape sequences:
  1108. X.RS
  1109. X.PD 0
  1110. X.TP
  1111. X.B \ea
  1112. Xbell character
  1113. X.TP
  1114. X.B \en
  1115. Xlinefeed (newline)
  1116. X.TP
  1117. X.B \eb
  1118. Xbackspace
  1119. X.TP
  1120. X.B \et
  1121. Xhorizontal tab
  1122. X.TP
  1123. X.B \ev
  1124. Xvertical tab
  1125. X.TP
  1126. X.B \ef
  1127. Xform feed
  1128. X.TP
  1129. X.B \er
  1130. Xcarriage return
  1131. X.TP
  1132. X.B \ee
  1133. Xescape
  1134. X.TP
  1135. X.B \ennn
  1136. Xcharacter code in octal
  1137. X.TP
  1138. X.B \eM\-xxx
  1139. Xcharacter or escape sequence with meta bit set
  1140. X.PD
  1141. X.PP
  1142. X.RE
  1143. XIn all other cases, \e escapes the following character.  Delete is
  1144. Xwritten as `\fB^?\fP'.
  1145. X.RE
  1146. X.TP
  1147. X\fBbreak\fP [ \fIn\fP ]
  1148. XExit from an enclosing \fBfor\fP, \fBwhile\fP,
  1149. X\fBuntil\fP, \fBselect\fP, or \fBrepeat\fP loop.  If \fIn\fP
  1150. Xis specified, then break \fIn\fP levels instead of just one.
  1151. X.TP
  1152. X\fBbuiltin\fP \fIname\fP [ \fIargs\fP ] ...
  1153. XExecutes the builtin \fIname\fP, with the given \fIargs\fP.
  1154. X.TP
  1155. X\fBbye\fP
  1156. XSame as \fBexit\fP.
  1157. X.TP
  1158. X.PD 0
  1159. X\fBcd\fP [ \fIarg\fP ]
  1160. X.TP
  1161. X\fBcd\fP \fIold\fP \fInew\fP
  1162. X.TP
  1163. X\fBcd\fP \(+-\fBn\fP
  1164. X.PD
  1165. XChange the current directory.  In the first form, change the
  1166. Xcurrent directory to \fIarg\fP, or to the value of \fBHOME\fP if
  1167. X\fIarg\fP is not specified.  If \fIarg\fP is \-, change to the
  1168. Xvalue of \fBOLDPWD\fP, the previous directory.
  1169. XIf a directory named \fIarg\fP is not found in the current directory
  1170. Xand \fIarg\fP does not contain a slash,
  1171. Xsearch each component of the shell parameter \fBcdpath\fP.
  1172. XIf the option \fBCDABLEVARS\fP is set, and a parameter named \fIarg\fP
  1173. Xexists whose value begins with a slash, treat its value as
  1174. Xthe directory.
  1175. X.RS
  1176. X.PP
  1177. XThe second form of \fBcd\fP substitutes the string \fInew\fP
  1178. Xfor the string \fIold\fP in the name of the current directory,
  1179. Xand tries to change to this new directory.
  1180. X.PP
  1181. XThe third form of \fBcd\fP is equivalent to \fBpopd\fP.
  1182. X.RE
  1183. X.TP
  1184. X\fBchdir\fP
  1185. XSame as \fBcd\fP.
  1186. X.TP
  1187. X\fBcontinue\fP [ \fInum\fP ]
  1188. XResume the next iteration of the enclosing
  1189. X\fBfor\fP, \fBwhile\fP, \fBuntil\fP, \fBselect\fP, or
  1190. X\fBrepeat\fP loop.  If \fIn\fP is specified, break out of
  1191. X\fIn\fP \- 1 loops and resume at the \fIn\fPth enclosing loop.
  1192. X.TP
  1193. X\fBdeclare\fP [ \fIarg\fP ... ]
  1194. XSame as \fBtypeset\fP.
  1195. X.TP
  1196. X\fBdirs\fP [ \-\fBv\fP ] [ \fIarg\fP ... ]
  1197. XWith no arguments, print the contents of the directory stack.
  1198. XIf the \-\fBv\fP option is given, number the directories
  1199. Xin the stack when printing.
  1200. XDirectories are added to this stack with the \fBpushd\fP command,
  1201. Xand removed with the \fBcd\fP or \fBpopd\fP commands.
  1202. XIf arguments are specified, load them onto the directory stack,
  1203. Xreplacing anything that was there, and push the current directory
  1204. Xonto the stack.
  1205. X.TP
  1206. X\fBdisable\fP \fIarg\fP ...
  1207. XDisable the builtin \fIarg\fP temporarily.  This allows you to use
  1208. Xan external command with the same name as a shell builtin.
  1209. XActually the same as \fBunhash\fP.
  1210. XBuiltins can be enabled with the \fBenable\fP command.
  1211. X.TP
  1212. X\fBdisown\fP \fIjob\fP ...
  1213. XRemove the specified jobs from the job table; the shell will
  1214. Xno longer report their status, and will not complain if you
  1215. Xtry to exit an interactive shell with them running or stopped.
  1216. X.TP
  1217. X\fBecho\fP [ \-\fBn\fP ] [ \fIarg\fP ... ]
  1218. XWrite each \fIarg\fP on the standard output, with a space separating
  1219. Xeach one.
  1220. XIf the \-\fBn\fP flag is not present, print a newline at the end.
  1221. X\fBecho\fP recognizes the following escape sequences:
  1222. X.RS
  1223. X.PD 0
  1224. X.TP
  1225. X.B \eb
  1226. Xbackspace
  1227. X.TP
  1228. X.B \ec
  1229. Xdon't print an ending newline
  1230. X.TP
  1231. X.B \ee
  1232. Xescape
  1233. X.TP
  1234. X.B \ef
  1235. Xform feed
  1236. X.TP
  1237. X.B \en
  1238. Xnewline
  1239. X.TP
  1240. X.B \er
  1241. Xcarriage return
  1242. X.TP
  1243. X.B \et
  1244. Xhorizontal tab
  1245. X.TP
  1246. X.B \ev
  1247. Xvertical tab
  1248. X.TP
  1249. X.B \e\e
  1250. Xbackslash
  1251. X.TP
  1252. X.B \exxx
  1253. Xcharacter code in octal
  1254. X.PD
  1255. X.RE
  1256. X.TP
  1257. X\fBechotc\fP \fIcap\fP [ \fIarg\fP ... ]
  1258. XOutput the termcap string corresponding to the capability
  1259. X\fIcap\fP, with optional arguments.
  1260. X.TP
  1261. X\fBenable\fP \fIarg\fP ...
  1262. XEnable the specified builtin commands, presumably disabled earlier
  1263. Xwith \fBdisable\fP.
  1264. X.TP
  1265. X\fBeval\fP [ \fIarg\fP ... ]
  1266. XRead the arguments as input to the shell and execute the resulting
  1267. Xcommand(s) in the current shell process.
  1268. X.TP
  1269. X\fBexit\fP [ \fIn\fP ]
  1270. XExit the shell with the exit code specified by \fIn\fP; if none
  1271. Xis specified, use the exit code from the last command executed.
  1272. XAn EOF condition will also cause the shell to exit, unless
  1273. Xthe \fBIGNOREEOF\fP option is set.
  1274. X.TP
  1275. X\fBexport\fP [ \fIname\fP[=\fIvalue\fP] ... ]
  1276. XThe specified \fIname\fPs are marked for automatic export
  1277. Xto the environment of subsequently executed commands.
  1278. X.TP
  1279. X\fBfalse\fP
  1280. XDo nothing and return an exit code of 1.
  1281. X.TP
  1282. X.PD 0
  1283. X\fBfc\fP [ \-\fBe\fP \fIename\fP ] [ \-\fBnlr\fP ] [ \fIold\fP=\fInew\fP ... ] [ \fIfirst\fP [ \fIlast\fP ] ]
  1284. X.TP
  1285. X\fBfc\fP \-\fBRW\fP [ \fIfilename\fP ]
  1286. X.PD
  1287. XSelect a range of commands from \fIfirst\fP to \fIlast\fP from the
  1288. Xhistory list.
  1289. XThe arguments \fIfirst\fP and \fIlast\fP may be specified as a
  1290. Xnumber or as a string.  A negative number is used as an offset
  1291. Xto the current history event number.
  1292. XA string specifies the most recent event
  1293. Xbeginning with the given string.
  1294. XAll substitutions \fIold\fP=\fInew\fP, if any, are then performed
  1295. Xon the commands.
  1296. XIf the \-\fBl\fP flag is given, the resulting commands are listed on
  1297. Xstandard output.
  1298. XOtherwise the editor program \fIename\fP is invoked on a file containing
  1299. Xthese history events.  If \fIename\fP is not given, the value
  1300. Xof the parameter \fBFCEDIT\fP is used.  If \fIename\fP is "\-",
  1301. Xno editor is invoked.  When editing is complete, the edited
  1302. Xcommand(s) is executed.  
  1303. XIf \fIfirst\fP is not specified, it will be set to \-1 (the most recent
  1304. Xevent), or to -16 if the \-\fBl\fP flag is given.
  1305. XIf \fIlast\fP is not specified, it will be set to \fIfirst\fP,
  1306. Xor to \-1 if the \-\fBl\fP flag is given.
  1307. XThe flag \-\fBr\fP reverses the order of the commands and the
  1308. Xflag \-\fBn\fP suppresses command numbers when listing.
  1309. X.RS
  1310. X.PP
  1311. X\fBfc\fP \-\fBR\fP reads the history from the given file,
  1312. Xand \fBfc\fP \-\fBW\fP writes the history out to the given file.
  1313. X.RE
  1314. X.TP
  1315. X.PD 0
  1316. X\fBfg\fP [ \fIjob\fP ... ]
  1317. X.TP
  1318. X\fIjob\fP ...
  1319. X.PD
  1320. XBring the specified \fIjob\fPs to the foreground.
  1321. XIf no \fIjob\fP is specified, use the current job.
  1322. X.TP
  1323. X\fBfunctions\fP [ \(+-\fBtu\fP ] [ \fIname\fP ... ]
  1324. XEquivalent to \fBtypeset\fP \-\fBf\fP.
  1325. X.TP
  1326. X\fBgetln\fP \fIname\fP ...
  1327. XRead the top value from the buffer stack and put it in
  1328. Xthe shell parameter \fIname\fP.  Equivalent to
  1329. X\fBread\fP \-\fBzr\fP.
  1330. X.TP
  1331. X\fBgetopts\fP \fIoptstring\fP \fIname\fP [ \fIarg\fP ... ]
  1332. XChecks \fBarg\fP for legal options.  If \fIarg\fP is omitted,
  1333. Xuse the positional parameters.  A valid option argument
  1334. Xbegins with a + or a \-.  An argument not beginning with
  1335. Xa + or a \-, or the argument \-\-, ends the options.
  1336. X\fIoptstring\fP contains the letters that \fBgetopts\fP
  1337. Xrecognizes.  If a letter is followed by a `:', that option
  1338. Xis expected to have an argument.  The options can be
  1339. Xseparated from the argument by blanks.
  1340. X.RS
  1341. X.PP
  1342. XEach time it is invoked, \fBgetopts\fP places the option letter it finds
  1343. Xin the shell parameter \fIname\fP, prepended with a + when
  1344. X\fIarg\fP begins with a +.  The index of the next \fIarg\fP
  1345. Xis stored in \fBOPTIND\fP.  The option argument, if any,
  1346. Xis stored in \fBOPTARG\fP.
  1347. X.PP
  1348. XA leading : in \fIoptstring\fP causes \fBgetopts\fP to store the
  1349. Xletter of the invalid option in \fBOPTARG\fP, and to set \fIname\fP
  1350. Xto `?' for an unknown option and to `:' when a required option
  1351. Xis missing.  Otherwise, \fBgetopts\fP prints an error
  1352. Xmessage.  The exit status is nonzero when there are no more options.
  1353. X.RE
  1354. X.TP
  1355. X\fBhash\fP \fIname\fP \fIpath\fP
  1356. XPuts \fIname\fP in the command hash table, associating it with
  1357. Xthe pathname \fIpath\fP.  Whenever \fIname\fP is used as a command
  1358. Xargument, the shell will try to execute the file given by \fIpath\fP.
  1359. X.TP
  1360. X\fBhistory\fP [ \-\fBnr\fP ] [ \fIfirst\fP [ \fIlast\fP ] ]
  1361. XSame as \fBfc\fP \-\fBl\fP.
  1362. X.TP
  1363. X\fBinteger\fP
  1364. XSame as \fBtypeset\fP \-\fBi\fP.
  1365. X.TP
  1366. X\fBjobs\fP [ \-\fBlp\fP ] [ \fIjob\fP ... ]
  1367. XLists information about each given job, or all jobs
  1368. Xif \fIjob\fP is omitted.  The \-\fBl\fP flag lists process
  1369. Xids, and the \-\fBp\fP flag lists process groups.
  1370. X.TP
  1371. X.PD 0
  1372. X\fBkill\fP [ \-\fIsig\fP ] \fIjob\fP ...
  1373. X.TP
  1374. X\fBkill\fP \-\fBl\fP
  1375. X.PD
  1376. XSends either SIGTERM or the specified signal to the given
  1377. Xjobs or processes.
  1378. XSignals are given by number or by names
  1379. X(with the prefix "SIG" removed).
  1380. XIf the signal being sent is not KILL or CONT, then the job
  1381. Xwill be sent a CONT signal if it is stopped.
  1382. XThe argument \fIjob\fP can be the process id of a job
  1383. Xnot in the job list.
  1384. XIn the second form, \fBkill\fP \-\fBl\fP, the signal names
  1385. Xare listed.
  1386. X.TP
  1387. X\fBlet\fP \fIarg\fP ...
  1388. XEvaluate each \fIarg\fP as an arithmetic expression.
  1389. XSee \fBARITHMETIC EVALUATION\fP above for a description
  1390. Xof arithmetic expressions.  The exit status is 0 if the
  1391. Xvalue of the last expression is nonzero, and 1 otherwise.
  1392. X.TP
  1393. X.PD 0
  1394. X\fBlimit\fP [ \-\fBh\fP ] [ \fIresource\fP [ \fIlimit\fP ] ] ...
  1395. X.TP
  1396. X\fBlimit\fP \-\fBs\fP
  1397. X.PD
  1398. XLimit the resource consumption of children of the current shell.
  1399. XIf \fIlimit\fP is not specified, print the current limit placed
  1400. Xon \fIresource\fP; otherwise
  1401. Xset the limit to the specified value.  If the \-\fBh\fP flag
  1402. Xis given, use hard limits instead of soft limits.
  1403. XIf no \fIresource\fP is given, print all limits.
  1404. X.RS
  1405. X.PP
  1406. X\fIresource\fP is one of:
  1407. X.PP
  1408. X.PD 0
  1409. X.TP
  1410. X.B cputime
  1411. XMaximum CPU seconds per process.
  1412. X.TP
  1413. X.B filesize
  1414. XLargest single file allowed.
  1415. X.TP
  1416. X.B datasize
  1417. XMaximum data size (including stack) for each process.
  1418. X.TP
  1419. X.B stacksize
  1420. XMaximum stack size for each process.
  1421. X.TP
  1422. X.B coredumpsize
  1423. XMaximum size of a core dump.
  1424. X.TP
  1425. X.B resident
  1426. XMaximum resident set size.
  1427. X.TP
  1428. X.B descriptors
  1429. XMaximum value for a file descriptor.
  1430. X.PD
  1431. X.PP
  1432. X\fIlimit\fP is a number, with an optional scaling factor, as follows:
  1433. X.PP
  1434. X.PD 0
  1435. X.TP
  1436. X\fIn\fPh
  1437. Xhours.
  1438. X.TP
  1439. X\fIn\fPk
  1440. Xkilobytes. 
  1441. XThis is the default for all but cputime.
  1442. X.TP
  1443. X\fIn\fPm
  1444. Xmegabytes or minutes.
  1445. X.TP
  1446. X\fImm\fP:\fBss\fP
  1447. Xminutes and seconds.
  1448. X.PD
  1449. X.RE
  1450. X.TP
  1451. X\fBlocal\fP
  1452. XSame as \fBtypeset\fP.
  1453. X.TP
  1454. X\fBlog\fP
  1455. XList all users currently logged in who are affected by
  1456. Xthe current setting of the \fBwatch\fP parameter.
  1457. X.TP
  1458. X\fBlogout\fP
  1459. XExit the shell, if this is a login shell.
  1460. X.TP
  1461. X\fBpopd\fP [ \(+-\fIn\fP ]
  1462. XRemoves entries from the directory stack.  With no arguments,
  1463. Xremoves the top directory from the stack, and performs a \fBcd\fP
  1464. Xto the new top directory.  With an argument of the form +\fIn\fP,
  1465. Xremove the \fIn\fPth entry counting from the left of the list
  1466. Xshown by the \fBdirs\fP command, starting with zero, and change
  1467. Xto that directory.  With an argument of the form \-\fIn\fP,
  1468. Xremove the \fIn\fPth entry counting from the right.
  1469. XIf the \fBPUSHD_MINUS\fP option is set, the meanings of +
  1470. Xand \- in this context are swapped.
  1471. X.TP
  1472. X\fBprint\fP [ \-\fBRnrslz0DP\fP ] [ \fIarg\fP ... ]
  1473. XWith no flags or with flag \-, the arguments are printed on
  1474. Xthe standard output as described by \fBecho\fP.
  1475. X.RS
  1476. X.PD 0
  1477. X.TP
  1478. X\-\fBR\fP, \-\fBr\fP
  1479. Xignore the escape conventions of \fBecho\fP.
  1480. XThe \-\fBR\fP option will print all subsequent
  1481. Xarguments and options.
  1482. X.TP
  1483. X\-\fBs\fP
  1484. Xplace the results in the history list instead of on the standard output.
  1485. X.TP
  1486. X\-\fBn\fP
  1487. Xdo not add a newline to the output.
  1488. X.TP
  1489. X\-\fBl\fP
  1490. Xprint the arguments separated by newlines instead of spaces.
  1491. X.TP
  1492. X\-\fB0\fP
  1493. Xprint the arguments separated and terminated by nulls.
  1494. X.TP
  1495. X\-\fBz\fP
  1496. Xpush the arguments onto the editing buffer stack, separated by spaces;
  1497. Xno escape sequences are recognized.
  1498. X.TP
  1499. X\-\fBD\fP
  1500. Xtreat the arguments as directory names, replacing prefixes with ~
  1501. Xexpressions, as appropriate.
  1502. X.TP
  1503. X\-\fBP\fP
  1504. Xrecognize the same escape sequences as in the \fBPROMPT\fP parameter.
  1505. X.PD
  1506. X.RE
  1507. X.TP
  1508. X.PD 0
  1509. X\fBpushd\fP [ \fIarg\fP ]
  1510. X.TP
  1511. X\fBpushd\fP \fIold\fP \fInew\fP
  1512. X.TP
  1513. X\fBpushd\fP \(+-\fBn\fP
  1514. X.PD
  1515. XChange the current directory, and push the old current directory
  1516. Xonto the directory stack.  In the first form, change the
  1517. Xcurrent directory to \fIarg\fP.
  1518. XIf \fIarg\fP is not specified, change to the second directory
  1519. Xon the stack (that is, exchange the top two entries), or
  1520. Xchange to the value of \fBHOME\fP if the \fBPUSHD_TO_HOME\fP
  1521. Xoption is set or if there is only one entry on the stack.
  1522. XIf \fIarg\fP is \-, change to the
  1523. Xvalue of \fBOLDPWD\fP, the previous directory.
  1524. XIf a directory named \fIarg\fP is not found in the current directory
  1525. Xand \fIarg\fP does not contain a slash,
  1526. Xsearch each component of the shell parameter \fBcdpath\fP.
  1527. XIf the option \fBCDABLEVARS\fP is set, and a parameter named \fIarg\fP
  1528. Xexists whose value begins with a slash, treat its value as
  1529. Xthe directory.
  1530. XIf the option \fBPUSHD_SILENT\fP is not set, the directory
  1531. Xstack will be printed after a \fBpushd\fP is performed.
  1532. X.RS
  1533. X.PP
  1534. XThe second form of \fBpushd\fP substitutes the string \fInew\fP
  1535. Xfor the string \fIold\fP in the name of the current directory,
  1536. Xand tries to change to this new directory.
  1537. X.PP
  1538. XThe third form of \fBpushd\fP is equivalent to \fBpopd\fP.
  1539. X.RE
  1540. X.TP
  1541. X\fBpwd\fP
  1542. XEquivalent to \fBprint \-R $PWD\fP.
  1543. X.TP
  1544. X\fBr\fP
  1545. XEquivalent to \fBfc \-e \-\fP.
  1546. X.TP
  1547. X\fBread\fP [ \-\fBrz\fP ] [ \fIname\fP?\fIprompt\fP ] [ \fIname\fP ...  ]
  1548. XRead one line and break it into fields using the characters
  1549. Xin \fBIFS\fP as separators.  In raw mode, \-\fBr\fP, a \e
  1550. Xat the end of a line does not signify line continuation.
  1551. XIf the \-\fBz\fP flag is set, read from the editor buffer stack.
  1552. XThe first field is assigned to the first \fIname\fP, the second field
  1553. Xto the second \fIname\fP, etc., with leftover
  1554. Xfields assigned to the last \fIname\fP.
  1555. XIf \fIname\fP is omitted then \fBREPLY\fP is used.
  1556. XThe exit status is 0 unless end-of-file is encountered.
  1557. XIf the first argument contains a \fB?\fP, the remainder of this
  1558. Xword is used as a \fIprompt\fP on standard error when the shell
  1559. Xis interactive.  The exit status is 0 unless an end-of-file
  1560. Xis encountered.
  1561. X.TP
  1562. X\fBreadonly\fP [ \fIname\fP[=\fIvalue\fP] ] ...
  1563. XThe given \fInames\fP are marked readonly; these names
  1564. Xcannot be changed by subsequent assignment.
  1565. X.TP
  1566. X\fBrehash\fP
  1567. XRescan the command path, rebuilding the hash table of commands.
  1568. X.TP
  1569. X\fBreturn\fP [ \fIn\fP ]
  1570. XCauses a shell function or \fB\&.\fP script to return to
  1571. Xthe invoking script
  1572. Xwith the return status specified by \fIn\fP.  If \fIn\fP
  1573. Xis omitted then the return status is that of the last command
  1574. Xexecuted.
  1575. X.TP
  1576. X.PD 0
  1577. X\fBsched\fP [+]\fIhh\fP:\fImm\fP \fIcommand\fP ...
  1578. X.TP
  1579. X\fBsched\fP [ \-\fIitem\fP ]
  1580. X.PD
  1581. XMake an entry in the scheduled list of commands to execute.
  1582. XThe time may be specified in either absolute or relative time.
  1583. XWith no arguments, prints the list of scheduled commands.
  1584. XWith the argument \-\fIitem\fP, removes the given item
  1585. Xfrom the list.
  1586. X.TP
  1587. X\fBset\fP [ \(+-\fIoptions\fP ] [ \(+-\fBo\fP \fIoption name\fP ] ... [ \-\fBA\fP \fIname\fP ] [ \fIarg\fP ] ...
  1588. XSet the options for the shell and/or set the positional parameters, or
  1589. Xdeclare an array.  For the meaning of the flags, see
  1590. X\fBOPTIONS\fP above.
  1591. XFlags may be specified by name using the \-\fBo\fP option.
  1592. XIf the \-\fBA\fP flag is specified, \fIname\fP is set to an
  1593. Xarray containing the given \fIarg\fPs.
  1594. XOtherwise the positional parameters are set.
  1595. XIf no arguments are given, then the names and values
  1596. Xof all parameters are printed on the standard output.
  1597. XIf the only argument is +, the names of all parameters are printed.
  1598. X.TP
  1599. X\fBsetopt\fP [ \(+-\fIoptions\fP ] [ \fIname\fP ... ]
  1600. XSet the options for the shell.  All options specified either
  1601. Xwith flags or by name are set.  If no arguments are supplied,
  1602. Xthe names of all options currently set are printed.
  1603. XIn option names, case is insignificant, and all underscore
  1604. Xcharacters are ignored.
  1605. X.TP
  1606. X\fBshift\fP [ \fIn\fP ]
  1607. XThe positional parameters from $\fIn\fP+\fB1\fP ... are renamed
  1608. X$\fB1\fP, where \fIn\fP is an arithmetic expression that
  1609. Xdefaults to 1.
  1610. X.TP
  1611. X\fBsource\fP
  1612. XSame as \fB.\fP.
  1613. X.TP
  1614. X\fBsuspend\fP [ \-\fBf\fP ]
  1615. XSuspend the execution of the shell (send it a \fBSIGTSTP\fP)
  1616. Xuntil it receives a \fBSIGCONT\fP.
  1617. XIf the \-\fBf\fP option is not given, complain if this is a login shell.
  1618. X.TP
  1619. X.PD 0
  1620. X\fBtest\fP \fIarg\fP ...
  1621. X.TP
  1622. X\fB[\fP \fIarg\fP ... \fB]\fP
  1623. X.PD
  1624. XLike the system version of \fBtest\fP.  Added for compatibility;
  1625. Xuse conditional expressions instead.
  1626. X.TP
  1627. X\fBtimes\fP
  1628. XPrint the accumulated user and system times for the shell
  1629. Xand for processes run from the shell.
  1630. X.TP
  1631. X\fBtrap\fP [ \fIarg\fP ] [ \fIsig\fP ] ...
  1632. X\fIarg\fP is a command to be read and executed when the shell
  1633. Xreceives \fIsig\fP.  Each \fIsig\fP can be given as a number
  1634. Xor as the name of a signal.
  1635. XIf \fIarg\fP is \-, then all traps \fIsig\fP are reset to their
  1636. Xdefault values.  If \fIarg\fP is the null string, then this signal
  1637. Xis ignored by the shell and by the commands it invokes.
  1638. XIf \fIsig\fP is \fBERR\fP then \fIarg\fP will be executed
  1639. SHAR_EOF
  1640. true || echo 'restore of zsh2.1/man/man1/zsh.1 failed'
  1641. fi
  1642. echo 'End of zsh2.1.0 part 3'
  1643. echo 'File zsh2.1/man/man1/zsh.1 is continued in part 4'
  1644. echo 4 > _shar_seq_.tmp
  1645. exit 0
  1646.  
  1647. exit 0 # Just in case...
  1648. -- 
  1649. Kent Landfield                   INTERNET: kent@sparky.IMD.Sterling.COM
  1650. Sterling Software, IMD           UUCP:     uunet!sparky!kent
  1651. Phone:    (402) 291-8300         FAX:      (402) 291-4362
  1652. Please send comp.sources.misc-related mail to kent@uunet.uu.net.
  1653.