home *** CD-ROM | disk | FTP | other *** search
/ Hacker Chronicles 1 / HACKER1.ISO / hack / cshell.doc < prev    next >
Text File  |  1992-03-04  |  61KB  |  1,874 lines

  1. cat /usr/spool/public/unix_stuff/csh.doc
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                An introduction to the C shell
  13.  
  14.  
  15.                         William Joy
  16.  
  17.                  Computer Science Division
  18.  Department of Electrical Engineering and Computer Science
  19.              University of California, Berkeley
  20.                  Berkeley, California 94720
  21.  
  22.  
  23.  
  24.                           _A_B_S_T_R_A_C_T
  25.  
  26.           _C_s_h is a new command language interpreter for
  27.      UNIX* systems.  It incorporates good  features  of
  28.      other  shells  and  a _h_i_s_t_o_r_y mechanism similar to
  29.      the _r_e_d_o of INTERLISP.  While  incorporating  many
  30.      features  of other shells which make writing shell
  31.      programs  (shell  scripts)  easier,  most  of  the
  32.      features  unique  to _c_s_h are designed more for the
  33.      interactive UNIX user.
  34.  
  35.           UNIX users who have read a general  introduc-
  36.      tion  to  the  system  will  find a valuable basic
  37.      explanation of the shell  here.   Simple  terminal
  38.      interaction  with  _c_s_h  is  possible after reading
  39.      just the first  section  of  this  document.   The
  40.      second  section  describes the shells capabilities
  41.      which you can explore  after  you  have  begun  to
  42.      become  acquainted with the shell.  Later sections
  43.      introduce  features  which  are  useful,  but  not
  44.      necessary for all users of the shell.
  45.  
  46.           Back matter includes an appendix listing spe-
  47.      cial  characters  of  the  shell and a glossary of
  48.      terms and commands introduced in this manual.
  49.  
  50.  
  51.  
  52. March 10, 1984
  53.  
  54.  
  55.  
  56.  
  57. __________________________
  58. *UNIX is a Trademark of Bell Laboratories.
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.                An introduction to the C shell
  79.  
  80.  
  81.                         William Joy
  82.  
  83.                  Computer Science Division
  84.  Department of Electrical Engineering and Computer Science
  85.              University of California, Berkeley
  86.                  Berkeley, California 94720
  87.  
  88.  
  89.  
  90. _I_n_t_r_o_d_u_c_t_i_o_n
  91.  
  92.      A _s_h_e_l_l is a command language interpreter.  _C_s_h is  the
  93. name  of  one  particular  command interpreter on UNIX.  The
  94. primary purpose of _c_s_h is to translate command  lines  typed
  95. at  a  terminal  into  system actions, such as invocation of
  96. other programs.  _C_s_h is a user program  just  like  any  you
  97. might  write.   Hopefully, _c_s_h will be a very useful program
  98. for you in interacting with the UNIX system.
  99.  
  100.      In addition to this document, you will want to refer to
  101. a  copy of the UNIX programmer's manual.  The _c_s_h documenta-
  102. tion in the  manual  provides  a  full  description  of  all
  103. features of the shell and is a final reference for questions
  104. about the shell.
  105.  
  106.      Many words in  this  document  are  shown  in  _i_t_a_l_i_c_s.
  107. These  are  important  words;  names  of commands, and words
  108. which have special meaning in discussing the shell and UNIX.
  109. Many  of  the  words are defined in a glossary at the end of
  110. this document.  If you don't know what is meant by  a  word,
  111. you should look for it in the glossary.
  112.  
  113. _A_c_k_n_o_w_l_e_d_g_e_m_e_n_t_s
  114.  
  115.      Numerous people have provided good input about previous
  116. versions of _c_s_h and aided in its debugging and in the debug-
  117. ging of its documentation.  I would especially like to thank
  118. Michael  Ubell who made the crucial observation that history
  119. commands could be done well over the word structure of input
  120. text,  and  implemented  a prototype history mechanism in an
  121. older version of the shell.  Eric Allman has also provided a
  122. large  number  of  useful  comments on the shell, helping to
  123. unify those concepts which are present and to  identify  and
  124. eliminate  useless  and  marginally  useful  features.  Mike
  125. O'Brien  suggested  the  pathname  hashing  mechanism  which
  126. speeds  command  execution.   Jim Kulp added the job control
  127. and directory stack primitives and added their documentation
  128. to this introduction.
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.                            - 2 -
  139.  
  140.  
  141. _1.  _T_e_r_m_i_n_a_l _u_s_a_g_e _o_f _t_h_e _s_h_e_l_l
  142.  
  143. _1._1.  _T_h_e _b_a_s_i_c _n_o_t_i_o_n _o_f _c_o_m_m_a_n_d_s
  144.  
  145.      A _s_h_e_l_l in UNIX acts mostly as a medium  through  which
  146. other  _p_r_o_g_r_a_m_s  are invoked.  While it has a set of _b_u_i_l_t_i_n
  147. functions which it performs directly,  most  commands  cause
  148. execution  of  programs  that  are, in fact, external to the
  149. shell.  The shell is thus  distinguished  from  the  command
  150. interpreters  of  other  systems both by the fact that it is
  151. just a user program, and by the fact that it is used  almost
  152. exclusively as a mechanism for invoking other programs.
  153.  
  154.      _C_o_m_m_a_n_d_s in the  UNIX  system  consist  of  a  list  of
  155. strings  or  _w_o_r_d_s interpreted as a _c_o_m_m_a_n_d _n_a_m_e followed by
  156. _a_r_g_u_m_e_n_t_s.  Thus the command
  157.  
  158.         mail bill
  159.  
  160. consists of two words.  The first word _m_a_i_l names  the  com-
  161. mand  to  be  executed,  in this case the mail program which
  162. sends messages to other users.  The shell uses the  name  of
  163. the  command  in  attempting to execute it for you.  It will
  164. look in a number of _d_i_r_e_c_t_o_r_i_e_s for a  file  with  the  name
  165. _m_a_i_l which is expected to contain the mail program.
  166.  
  167.      The rest of the words of the command are given as _a_r_g_u_-
  168. _m_e_n_t_s  to  the  command itself when it is executed.  In this
  169. case we specified also the argument  _b_i_l_l  which  is  inter-
  170. preted  by the _m_a_i_l program to be the name of a user to whom
  171. mail is to be sent.  In normal terminal usage we  might  use
  172. the _m_a_i_l command as follows.
  173.  
  174.         % mail bill
  175.         I have a question about the csh documentation.
  176.         My document seems to be missing page 5.
  177.         Does a page five exist?
  178.                 Bill
  179.         EOT
  180.         %
  181.  
  182.  
  183.      Here we typed a message to send to _b_i_l_l and ended  this
  184. message with a |^D which sent an end-of-file to the mail pro-
  185. gram.  (Here and  throughout  this  document,  the  notation
  186. ``|^_x'' is to be read ``control-_x'' and represents the strik-
  187. ing of the _x key while the control key is  held  down.)  The
  188. mail  program then echoed the characters `EOT' and transmit-
  189. ted our message.  The characters `% '  were  printed  before
  190. and  after  the  mail  command by the shell to indicate that
  191. input was needed.
  192.  
  193.      After typing the `% ' prompt the shell was reading com-
  194. mand  input  from our terminal.  We typed a complete command
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.                            - 3 -
  205.  
  206.  
  207. `mail bill'.  The shell then executed the _m_a_i_l program  with
  208. argument  _b_i_l_l  and went dormant waiting for it to complete.
  209. The mail program then read input from our terminal until  we
  210. signalled  an  end-of-file  via  typing a |^D after which the
  211. shell noticed that mail had completed and signaled  us  that
  212. it  was  ready  to  read from the terminal again by printing
  213. another `% ' prompt.
  214.  
  215.      This is the essential pattern of all  interaction  with
  216. UNIX  through the shell.  A complete command is typed at the
  217. terminal, the shell executes the command and when this  exe-
  218. cution  completes, it prompts for a new command.  If you run
  219. the editor for an hour, the shell will  patiently  wait  for
  220. you  to finish editing and obediently prompt you again when-
  221. ever you finish editing.
  222.  
  223.      An example of a useful command you can execute  now  is
  224. the  _t_s_e_t  command,  which  sets  the default _e_r_a_s_e and _k_i_l_l
  225. characters on your terminal - the erase character erases the
  226. last  character  you typed and the kill character erases the
  227. entire line you have entered so far.  By default, the  erase
  228. character is `#' and the kill character is `@'.  Most people
  229. who use CRT displays prefer to use the backspace (|^H)  char-
  230. acter  as  their  erase character since it is then easier to
  231. see what you have typed so far.  You can make this  be  true
  232. by typing
  233.  
  234.         tset -e
  235.  
  236. which tells the program _t_s_e_t to set the erase character, and
  237. its default setting for this character is a backspace.
  238.  
  239. _1._2.  _F_l_a_g _a_r_g_u_m_e_n_t_s
  240.  
  241.      A useful notion in UNIX is that  of  a  _f_l_a_g  argument.
  242. While  many arguments to commands specify file names or user
  243. names some arguments rather specify an  optional  capability
  244. of  the  command  which  you wish to invoke.  By convention,
  245. such arguments begin with the character `-' (hyphen).   Thus
  246. the command
  247.  
  248.         ls
  249.  
  250. will produce a list of the  files  in  the  current  _w_o_r_k_i_n_g
  251. _d_i_r_e_c_t_o_r_y.  The option -_s is the size option, and
  252.  
  253.         ls -s
  254.  
  255. causes _l_s to also give, for each file the size of  the  file
  256. in  blocks  of  512 characters.  The manual section for each
  257. command in the UNIX reference  manual  gives  the  available
  258. options for each command.  The _l_s command has a large number
  259. of useful and interesting options.  Most other commands have
  260. either no options or only one or two options.  It is hard to
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.                            - 4 -
  271.  
  272.  
  273. remember options of commands which are not  used  very  fre-
  274. quently,  so  most  UNIX  utilities  perform only one or two
  275. functions rather than having  a  large  number  of  hard  to
  276. remember options.
  277.  
  278. _1._3.  _O_u_t_p_u_t _t_o _f_i_l_e_s
  279.  
  280.      Commands that normally read input or  write  output  on
  281. the  terminal  can  also  be executed with this input and/or
  282. output done to a file.
  283.  
  284.      Thus suppose we wish to save the current date in a file
  285. called `now'.  The command
  286.  
  287.         date
  288.  
  289. will print the  current  date  on  our  terminal.   This  is
  290. because  our terminal is the default _s_t_a_n_d_a_r_d _o_u_t_p_u_t for the
  291. date command and the date command prints  the  date  on  its
  292. standard  output.   The  shell lets us _r_e_d_i_r_e_c_t the _s_t_a_n_d_a_r_d
  293. _o_u_t_p_u_t of a command through a notation using the _m_e_t_a_c_h_a_r_a_c_-
  294. _t_e_r  `>'  and  the  name  of  the file where output is to be
  295. placed.  Thus the command
  296.  
  297.         date > now
  298.  
  299. runs the _d_a_t_e command such that its standard output  is  the
  300. file  `now'  rather  than  the  terminal.  Thus this command
  301. places the current date and time into the file `now'.  It is
  302. important to know that the _d_a_t_e command was unaware that its
  303. output was going to a file rather than to the terminal.  The
  304. shell  performed  this  _r_e_d_i_r_e_c_t_i_o_n before the command began
  305. executing.
  306.  
  307.      One other thing to note here is  that  the  file  `now'
  308. need  not have existed before the _d_a_t_e command was executed;
  309. the shell would have created the file if it did  not  exist.
  310. And  if  the  file  did exist?  If it had existed previously
  311. these previous contents would have been discarded!  A  shell
  312. option  _n_o_c_l_o_b_b_e_r  exists  to  prevent  this  from happening
  313. accidentally; it is discussed in section 2.2.
  314.  
  315.      The system normally keeps files which you  create  with
  316. `>'  and  all other files.  Thus the default is for files to
  317. be permanent.  If you wish to create a file  which  will  be
  318. removed  automatically,  you  can  begin its name with a `#'
  319. character, this `scratch' character denotes  the  fact  that
  320. the file will be a scratch file.*  The  system  will  remove
  321. __________________________
  322. *Note that if your erase character is a `#',  you  will
  323. have  to precede the `#' with a `\'.  The fact that the
  324. `#' character is the old (pre-CRT) standard erase char-
  325. acter  means that it seldom appears in a file name, and
  326. allows this convention to be used  for  scratch  files.
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.                            - 5 -
  337.  
  338.  
  339. such files after a couple of days, or sooner if  file  space
  340. becomes  very  tight.   Thus,  in  running  the _d_a_t_e command
  341. above, we don't really want to save the output  forever,  so
  342. we would more likely do
  343.  
  344.         date > #now
  345.  
  346.  
  347. _1._4.  _M_e_t_a_c_h_a_r_a_c_t_e_r_s _i_n _t_h_e _s_h_e_l_l
  348.  
  349.      The shell has a  large  number  of  special  characters
  350. (like  `>')  which  indicate special functions.  We say that
  351. these notations have _s_y_n_t_a_c_t_i_c and _s_e_m_a_n_t_i_c meaning  to  the
  352. shell.   In  general,  most  characters  which  are  neither
  353. letters nor digits have special meaning to  the  shell.   We
  354. shall  shortly learn a means of _q_u_o_t_a_t_i_o_n which allows us to
  355. use _m_e_t_a_c_h_a_r_a_c_t_e_r_s without the shell treating  them  in  any
  356. special way.
  357.  
  358.      Metacharacters normally have effect only when the shell
  359. is reading our input.  We need not worry about placing shell
  360. metacharacters in a letter we are sending via _m_a_i_l, or  when
  361. we  are  typing in text or data to some other program.  Note
  362. that the shell is only reading input when  it  has  prompted
  363. with `% '.
  364.  
  365. _1._5.  _I_n_p_u_t _f_r_o_m _f_i_l_e_s; _p_i_p_e_l_i_n_e_s
  366.  
  367.      We learned above how to _r_e_d_i_r_e_c_t the _s_t_a_n_d_a_r_d _o_u_t_p_u_t of
  368. a  command  to  a file.  It is also possible to redirect the
  369. _s_t_a_n_d_a_r_d _i_n_p_u_t of a command from a file.  This is not  often
  370. necessary  since  most  commands will read from a file whose
  371. name is given as an argument.  We can give the command
  372.  
  373.         sort < data
  374.  
  375. to run the _s_o_r_t command with standard input, where the  com-
  376. mand  normally  reads  its  input, from the file `data'.  We
  377. would more likely say
  378.  
  379.         sort data
  380.  
  381. letting the _s_o_r_t command open  the  file  `data'  for  input
  382. itself since this is less to type.
  383.  
  384.      We should note that if we just typed
  385.  
  386.         sort
  387.  
  388. __________________________
  389. If  you are using a CRT, your erase character should be
  390. a |^H, as we demonstrated in section 1.1 how this  could
  391. be set up.
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.                            - 6 -
  403.  
  404.  
  405. then the sort program would sort  lines  from  its  _s_t_a_n_d_a_r_d
  406. _i_n_p_u_t.   Since  we  did  not _r_e_d_i_r_e_c_t the standard input, it
  407. would sort lines as we typed them on the terminal  until  we
  408. typed a |^D to indicate an end-of-file.
  409.  
  410.      A most useful capability is the ability to combine  the
  411. standard  output  of  one command with the standard input of
  412. another, i.e. to run the commands in a sequence known  as  a
  413. _p_i_p_e_l_i_n_e.  For instance the command
  414.  
  415.         ls -s
  416.  
  417. normally produces a list of the files in our directory  with
  418. the  size  of  each  in blocks of 512 characters.  If we are
  419. interested in learning which of our files is largest we  may
  420. wish  to have this sorted by size rather than by name, which
  421. is the default way in which _l_s sorts.  We could look at  the
  422. many  options of _l_s to see if there was an option to do this
  423. but would eventually discover that there is not.  Instead we
  424. can use a couple of simple options of the _s_o_r_t command, com-
  425. bining it with _l_s to get what we want.
  426.  
  427.      The -_n option of sort specifies a numeric  sort  rather
  428. than an alphabetic sort.  Thus
  429.  
  430.         ls -s | sort -n
  431.  
  432. specifies that the output of the _l_s  command  run  with  the
  433. option  -_s  is  to be _p_i_p_e_d to the command _s_o_r_t run with the
  434. numeric sort option.  This would give us a  sorted  list  of
  435. our  files  by  size, but with the smallest first.  We could
  436. then use the -_r reverse sort option and the _h_e_a_d command  in
  437. combination with the previous command doing
  438.  
  439.         ls -s | sort -n -r | head -5
  440.  
  441. Here we have taken a list of  our  files  sorted  alphabeti-
  442. cally,  each  with  the size in blocks.  We have run this to
  443. the standard input of the _s_o_r_t command  asking  it  to  sort
  444. numerically  in  reverse order (largest first).  This output
  445. has then been run into the command _h_e_a_d which gives  us  the
  446. first  few  lines.   In this case we have asked _h_e_a_d for the
  447. first 5 lines.  Thus this command gives  us  the  names  and
  448. sizes of our 5 largest files.
  449.  
  450.      The  notation  introduced  above  is  called  the  _p_i_p_e
  451. mechanism.   Commands  separated  by `|' characters are con-
  452. nected together by the shell and the standard output of each
  453. is  run  into  the standard input of the next.  The leftmost
  454. command in a pipeline will normally take its standard  input
  455. from  the terminal and the rightmost will place its standard
  456. output on the terminal.  Other examples of pipelines will be
  457. given  later  when  we  discuss  the  history mechanism; one
  458. important use of pipes which is illustrated there is in  the
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.                            - 7 -
  469.  
  470.  
  471. routing of information to the line printer.
  472.  
  473. _1._6.  _F_i_l_e_n_a_m_e_s
  474.  
  475.      Many commands to be executed will  need  the  names  of
  476. files  as  arguments.  UNIX _p_a_t_h_n_a_m_e_s consist of a number of
  477. _c_o_m_p_o_n_e_n_t_s separated by `/'.  Each component except the last
  478. names  a  directory  in which the next component resides, in
  479. effect specifying the _p_a_t_h of directories to follow to reach
  480. the file.  Thus the pathname
  481.  
  482.         /etc/motd
  483.  
  484. specifies a file in the directory `etc' which is a subdirec-
  485. tory  of  the _r_o_o_t directory `/'.  Within this directory the
  486. file named is `motd' which stands for `message of the  day'.
  487. A  _p_a_t_h_n_a_m_e  that begins with a slash is said to be an _a_b_s_o_-
  488. _l_u_t_e pathname since it is specified from the absolute top of
  489. the  entire  directory  hierarchy  of the system (the _r_o_o_t).
  490. _P_a_t_h_n_a_m_e_s which do not begin with  `/'  are  interpreted  as
  491. starting  in  the  current  _w_o_r_k_i_n_g  _d_i_r_e_c_t_o_r_y, which is, by
  492. default, your _h_o_m_e directory and can be changed  dynamically
  493. by the _c_d change directory command.  Such pathnames are said
  494. to be _r_e_l_a_t_i_v_e to the working directory since they are found
  495. by starting in the working directory and descending to lower
  496. levels of directories for each _c_o_m_p_o_n_e_n_t  of  the  pathname.
  497. If  the pathname contains no slashes at all then the file is
  498. contained in the working directory itself and  the  pathname
  499. is  merely the name of the file in this directory.  Absolute
  500. pathnames have no relation to the working directory.
  501.  
  502.      Most filenames consist  of  a  number  of  alphanumeric
  503. characters  and `.'s (periods).  In fact, all printing char-
  504. acters except `/' (slash) may appear in  filenames.   It  is
  505. inconvenient  to  have  most  non-alphabetic  characters  in
  506. filenames because many of these have special meaning to  the
  507. shell.    The   character  `.'  (period)  is  not  a  shell-
  508. metacharacter and is often used to separate the _e_x_t_e_n_s_i_o_n of
  509. a file name from the base of the name.  Thus
  510.  
  511.         prog.c prog.o prog.errs prog.output
  512.  
  513. are four related files.  They share a _b_a_s_e portion of a name
  514. (a  base  portion  being  that part of the name that is left
  515. when a trailing `.' and following characters which  are  not
  516. `.'  are  stripped  off).   The  file  `prog.c' might be the
  517. source for a C program, the file `prog.o' the  corresponding
  518. object  file, the file `prog.errs' the errors resulting from
  519. a compilation of the program and the file `prog.output'  the
  520. output of a run of the program.
  521.  
  522.      If we wished to refer to all four of these files  in  a
  523. command, we could use the notation
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.                            - 8 -
  535.  
  536.  
  537.         prog.*
  538.  
  539. This word is expanded by the shell, before  the  command  to
  540. which  it  is  an argument is executed, into a list of names
  541. which begin with `prog.'.  The character  `*'  here  matches
  542. any sequence (including the empty sequence) of characters in
  543. a file name.   The  names  which  match  are  alphabetically
  544. sorted and placed in the _a_r_g_u_m_e_n_t _l_i_s_t of the command.  Thus
  545. the command
  546.  
  547.         echo prog.*
  548.  
  549. will echo the names
  550.  
  551.         prog.c prog.errs prog.o prog.output
  552.  
  553. Note that the names are in sorted order  here,  and  a  dif-
  554. ferent  order  than  we listed them above.  The _e_c_h_o command
  555. receives four words as arguments, even though we only  typed
  556. one  word as as argument directly.  The four words were gen-
  557. erated by _f_i_l_e_n_a_m_e _e_x_p_a_n_s_i_o_n of the one input word.
  558.  
  559.      Other notations for _f_i_l_e_n_a_m_e _e_x_p_a_n_s_i_o_n are also  avail-
  560. able.   The  character `?' matches any single character in acan't open file tabs
  561.  
  562. filename.  Thus
  563.  
  564.         echo ? ?? ???
  565.  
  566. will echo a line of filenames; first those with one  charac-
  567. ter  names, then those with two character names, and finally
  568. those with three character names.  The names of each  length
  569. will be independently sorted.
  570.  
  571.      Another mechanism consists of a sequence of  characters
  572. between  `['  and `]'.  This metasequence matches any single
  573. character from the enclosed set.  Thus
  574.  
  575.         prog.[co]
  576.  
  577. will match
  578.  
  579.         prog.c prog.o
  580.  
  581. in the example above.  We  can  also  place  two  characters
  582. around a `-' in this notation to denote a range.  Thus
  583.  
  584.         chap.[1-5]
  585.  
  586. might match files
  587.  
  588.         chap.1 chap.2 chap.3 chap.4 chap.5
  589.  
  590. if they existed.  This is shorthand for
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.                            - 9 -
  602.  
  603.  
  604.         chap.[12345]
  605.  
  606. and otherwise equivalent.
  607.  
  608.      An important point to note is that if a list  of  argu-
  609. ment words to a command (an _a_r_g_u_m_e_n_t _l_i_s_t) contains filename
  610. expansion syntax, and  if  this  filename  expansion  syntax
  611. fails  to match any existing file names, then the shell con-
  612. siders this to be an error and prints a diagnostic
  613.  
  614.         No match.
  615.  
  616. and does not execute the command.
  617.  
  618.      Another very important point is  that  files  with  the
  619. character  `.' at the beginning are treated specially.  Nei-
  620. ther `*' or `?' or the `['  `]'  mechanism  will  match  it.
  621. This  prevents  accidental matching of the filenames `.' and
  622. `..' in the working directory which have special meaning  to
  623. the  system, as well as other files such as ._c_s_h_r_c which are
  624. not normally visible.  We will discuss the special  role  of
  625. the file ._c_s_h_r_c later.
  626.  
  627.      Another filename expansion mechanism  gives  access  to
  628. the  pathname  of  the  _h_o_m_e directory of other users.  This
  629. notation consists of the character `~' (tilde)  followed  by
  630. another  users'  login  name.  For instance the word `~bill'
  631. would map to the pathname `/usr/bill' if the home  directory
  632. for  `bill' was `/usr/bill'.  Since, on large systems, users
  633. may have login directories  scattered  over  many  different
  634. disk  volumes  with  different  prefix directory names, this
  635. notation provides a reliable way of accessing the  files  of
  636. other users.
  637.  
  638.      A special case of  this  notation  consists  of  a  `~'
  639. alone,  e.g.  `~/mbox'.   This  notation  is expanded by the
  640. shell into the file `mbox' in your _h_o_m_e directory, i.e. into
  641. `/usr/bill/mbox'  for  me  on Ernie Co-vax, the UCB Computer
  642. Science Department VAX  machine,  where  this  document  was
  643. prepared.   This  can  be very useful if you have used _c_d to
  644. change to another directory and have found a file  you  wish
  645. to copy using _c_p.  If I give the command
  646.  
  647.         cp thatfile ~
  648.  
  649. the shell will expand this command to
  650.  
  651.         cp thatfile /usr/bill
  652.  
  653. since my home directory is /usr/bill.
  654.  
  655.      There also exists a mechanism using the characters  `{'
  656. and  `}'  for  abbreviating a set of words which have common
  657. parts but cannot be  abbreviated  by  the  above  mechanisms
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.                            - 10 -
  668.  
  669.  
  670. because  they are not files, are the names of files which do
  671. not yet exist, are not thus  conveniently  described.   This
  672. mechanism  will  be described much later, in section 4.2, as
  673. it is used less frequently.
  674.  
  675. _1._7.  _Q_u_o_t_a_t_i_o_n
  676.  
  677.      We have already seen a number of metacharacters used by
  678. the  shell.   These metacharacters pose a problem in that we
  679. cannot use them directly as parts of words.  Thus  the  com-
  680. mand
  681.  
  682.         echo *
  683.  
  684. will not echo the character `*'.  It  will  either  echo  an
  685. sorted  list  of filenames in the current _w_o_r_k_i_n_g _d_i_r_e_c_t_o_r_y,
  686. or print the message `No match' if there are no files in the
  687. working directory.
  688.  
  689.      The recommended mechanism for placing characters  which
  690. are  neither numbers, digits, `/', `.' or `-' in an argument
  691. word to a command is to enclose  it  with  single  quotation
  692. characters `'', i.e.
  693.  
  694.         echo '*'
  695.  
  696. There is one special character `!' which is used by the _h_i_s_-
  697. _t_o_r_y  mechanism  of the shell and which cannot be _e_s_c_a_p_e_d by
  698. placing it within `'' characters.  It and the character  `''
  699. itself can be preceded by a single `\' to prevent their spe-
  700. cial meaning.  Thus
  701.  
  702.         echo \'\!
  703.  
  704. prints
  705.  
  706.         '!
  707.  
  708. These two mechanisms suffice to place any printing character
  709. into  a  word which is an argument to a shell command.  They
  710. can be combined, as in
  711.  
  712.         echo \''*'
  713.  
  714. which prints
  715.  
  716.         '*
  717.  
  718. since the first `\' escaped the first `'' and  the  `*'  was
  719. enclosed between `'' characters.
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.  
  731.  
  732.  
  733.                            - 11 -
  734.  
  735.  
  736. _1._8.  _T_e_r_m_i_n_a_t_i_n_g _c_o_m_m_a_n_d_s
  737.  
  738.      When you are executing a command and the shell is wait-
  739. ing for it to complete there are several ways to force it to
  740. stop.  For instance if you type the command
  741.  
  742.         cat /etc/passwd
  743.  
  744. the system will print a copy of a list of all users  of  the
  745. system  on  your  terminal.   This is likely to continue for
  746. several minutes unless you stop it.  You can send an  INTER-
  747. RUPT  _s_i_g_n_a_l  to the _c_a_t command by typing the DEL or RUBOUT
  748. key on your terminal.* Since _c_a_t does not take  any  precau-
  749. tions to avoid or otherwise handle this signal the INTERRUPT
  750. will cause it to terminate.  The shell notices that _c_a_t  has
  751. terminated  and  prompts  you  again  with `% '.  If you hit
  752. INTERRUPT again, the shell will just repeat its prompt since
  753. it handles INTERRUPT signals and chooses to continue to exe-
  754. cute commands rather than terminating like  _c_a_t  did,  which
  755. would have the effect of logging you out.
  756.  
  757.      Another way in which many programs  terminate  is  when
  758. they get an end-of-file from their standard input.  Thus the
  759. _m_a_i_l program in the first example above was terminated  when
  760. we  typed a |^D which generates an end-of-file from the stan-
  761. dard input.  The shell also terminates when it gets an  end-
  762. of-file  printing  `logout'; UNIX then logs you off the sys-
  763. tem.  Since  this  means  that  typing  too  many  |^D's  can
  764. accidentally  log  us  off,  the  shell  has a mechanism for
  765. preventing this.  This _i_g_n_o_r_e_e_o_f option will be discussed in
  766. section 2.2.
  767.  
  768.      If a command has its standard input redirected  from  a
  769. file,  then  it  will normally terminate when it reaches the
  770. end of this file.  Thus if we execute
  771.  
  772.         mail bill < prepared.text
  773.  
  774. the mail command will terminate without  our  typing  a  |^D.
  775. This  is  because  it  read  to  the end-of-file of our file
  776. `prepared.text' in which we placed a message for `bill' with
  777. an editor program.  We could also have done
  778.  
  779.         cat prepared.text | mail bill
  780.  
  781. since the _c_a_t command  would  then  have  written  the  text
  782. through  the pipe to the standard input of the mail command.
  783. When the _c_a_t command completed  it  would  have  terminated,
  784. closing  down  the  pipeline and the _m_a_i_l command would have
  785. received an end-of-file from it  and  terminated.   Using  a
  786. __________________________
  787. *Many users use _s_t_t_y(1) to change the interrupt charac-
  788. ter to |^C.
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.  
  798.  
  799.                            - 12 -
  800.  
  801.  
  802. pipe here is more complicated than redirecting input  so  we
  803. would  more likely use the first form.  These commands could
  804. also have been stopped by sending an INTERRUPT.
  805.  
  806.      Another  possibility  for  stopping  a  command  is  to
  807. suspend  its  execution temporarily, with the possibility of
  808. continuing execution later.  This is done by sending a  STOP
  809. signal  via  typing  a  |^Z.  This signal causes all commands
  810. running on the terminal (usually one but more if a  pipeline
  811. is  executing)  to become suspended.  The shell notices that
  812. the command(s) have been suspended, types `Stopped' and then
  813. prompts for a new command.  The previously executing command
  814. has been suspended, but otherwise  unaffected  by  the  STOP
  815. signal.  Any other commands can be executed while the origi-
  816. nal command remains suspended.  The suspended command can be
  817. continued using the _f_g command with no arguments.  The shell
  818. will then retype the command to remind you which command  is
  819. being  continued, and cause the command to resume execution.
  820. Unless any input files in use by the suspended command  have
  821. been  changed  in the meantime, the suspension has no effect
  822. whatsoever on the execution of the  command.   This  feature
  823. can  be very useful during editing, when you need to look at
  824. another  file  before  continuing.  An  example  of  command
  825. suspension follows.
  826.  
  827.  
  828.  
  829. _2.  _D_e_t_a_i_l_s _o_n _t_h_e _s_h_e_l_l _f_o_r _t_e_r_m_i_n_a_l _u_s_e_r_s
  830.  
  831. _2._1.  _S_h_e_l_l _s_t_a_r_t_u_p _a_n_d _t_e_r_m_i_n_a_t_i_o_n
  832.  
  833.      When you login, the shell is started by the  system  in
  834. your  _h_o_m_e  directory  and begins by reading commands from a
  835. file ._c_s_h_r_c in this directory.  All  shells  which  you  may
  836. start during your terminal session will read from this file.
  837. We will later see what kinds of commands are usefully placed
  838. there.   For  now  we  need not have this file and the shell
  839. does not complain about its absence.
  840.  
  841.      A _l_o_g_i_n _s_h_e_l_l, executed after you login to the  system,
  842. will,  after  it  reads  commands from ._c_s_h_r_c, read commands
  843. from a file ._l_o_g_i_n also in your home directory.   This  file
  844. contains  commands  which you wish to do each time you login
  845. to the UNIX system.  My ._l_o_g_i_n file looks something like:
  846.  
  847.         set ignoreeof
  848.         set mail=(/usr/spool/mail/bill)
  849.         echo "${prompt}users" ; users
  850.         alias ts \
  851.                 'set noglob ; eval `tset -s -m dialup:c100rv4pna -m plugboard:?hp2621nl *`';
  852.         ts; stty intr |^C kill |^U crt
  853.         set time=15 history=10
  854.         msgs -f
  855.         if (-e $mail) then
  856.                 echo "${prompt}mail"
  857.                 mail
  858.         endif
  859.  
  860.  
  861.      This file contains several commands to be  executed  by
  862. UNIX each time I login.  The first is a _s_e_t command which is
  863. interpreted directly by the shell.  It sets the shell  vari-
  864. able _i_g_n_o_r_e_e_o_f which causes the shell to not log me off if I
  865. hit |^D.  Rather, I use the _l_o_g_o_u_t command to log off of  the
  866. system.   By  setting  the _m_a_i_l variable, I ask the shell to
  867. watch for incoming mail to me.  Every 5  minutes  the  shell
  868. looks  for  this  file and tells me if more mail has arrived
  869. there.  An alternative to this is to put the command
  870.  
  871.         biff y
  872.  
  873. in place of this _s_e_t; this will  cause  me  to  be  notified
  874. immediately when mail arrives, and to be shown the first few
  875. lines of the new message.
  876.  
  877.      Next I set the shell variable `time'  to  `15'  causing
  878. the  shell  to  automatically print out statistics lines for
  879. commands which execute for at least 15 seconds of CPU  time.
  880. The  variable  `history' is set to 10 indicating that I want
  881. the shell to remember the last 10 commands  I  type  in  its
  882. _h_i_s_t_o_r_y _l_i_s_t, (described later).
  883.  
  884.  
  885.  
  886.                        March 11, 1984
  887.  
  888.  
  889.  
  890.  
  891.  
  892.                            - 2 -
  893.  
  894.  
  895.      I create an _a_l_i_a_s ``ts'' which executes a _t_s_e_t(1)  com-
  896. mand  setting  up the modes of the terminal.  The parameters
  897. to _t_s_e_t indicate the kinds of terminal which I  usually  use
  898. when  not  on  a  hardwired port.  I then execute ``ts'' and
  899. also use the _s_t_t_y command to change the interrupt  character
  900. to |^C and the line kill character to |^U.
  901.  
  902.      I then run the `msgs' program, which provides  me  with
  903. any  system  messages which I have not seen before; the `-f'
  904. option here prevents it from telling me  anything  if  there
  905. are  no  new  messages.  Finally, if my mailbox file exists,
  906. then I run the `mail' program to process my mail.
  907.  
  908.      When the `mail' and `msgs' programs finish,  the  shell
  909. will finish processing my ._l_o_g_i_n file and begin reading com-
  910. mands from the terminal, prompting for each with `% '.  When
  911. I  log  off  (by  giving  the _l_o_g_o_u_t command) the shell will
  912. print `logout' and execute commands from the file  `.logout'
  913. if  it  exists  in  my home directory.  After that the shell
  914. will terminate and UNIX will log me off the system.  If  the
  915. system  is  not  going down, I will receive a new login mes-
  916. sage.  In any case, after the `logout' message the shell  is
  917. committed to terminating and will take no further input from
  918. my terminal.
  919.  
  920. _2._2.  _S_h_e_l_l _v_a_r_i_a_b_l_e_s
  921.  
  922.      The shell maintains a set of _v_a_r_i_a_b_l_e_s.  We  saw  above
  923. the  variables  _h_i_s_t_o_r_y  and  _t_i_m_e which had values `10' and
  924. `15'.  In fact, each shell variable has as value an array of
  925. zero  or  more  _s_t_r_i_n_g_s.   Shell  variables  may be assigned
  926. values by the set command.  It has several forms,  the  most
  927. useful of which was given above and is
  928.  
  929.         set name=value
  930.  
  931.  
  932.      Shell variables may be used to store values  which  are
  933. to  be used in commands later through a substitution mechan-
  934. ism.  The shell variables most commonly referenced are, how-
  935. ever,  those  which the shell itself refers to.  By changing
  936. the values of these variables one can  directly  affect  the
  937. behavior of the shell.
  938.  
  939.      One of the most important  variables  is  the  variable
  940. _p_a_t_h.   This variable contains a sequence of directory names
  941. where the shell searches for commands.  The _s_e_t command with
  942. no  arguments  shows  the  value  of all variables currently
  943. defined (we usually say _s_e_t)  in  the  shell.   The  default
  944. value for path will be shown by _s_e_t to be
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.                        March 11, 1984
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.  
  962. _3.  _S_h_e_l_l _c_o_n_t_r_o_l _s_t_r_u_c_t_u_r_e_s _a_n_d _c_o_m_m_a_n_d _s_c_r_i_p_t_s
  963.  
  964. _3._1.  _I_n_t_r_o_d_u_c_t_i_o_n
  965.  
  966.      It is possible to place commands in files and to  cause
  967. shells to be invoked to read and execute commands from these
  968. files, which are called _s_h_e_l_l _s_c_r_i_p_t_s.  We here detail those
  969. features of the shell useful to the writers of such scripts.
  970.  
  971. _3._2.  _M_a_k_e
  972.  
  973.      It is important to first note what  shell  scripts  are
  974. _n_o_t  useful  for.   There  is a program called _m_a_k_e which is
  975. very useful for maintaining a group of related files or per-
  976. forming sets of operations on related files.  For instance a
  977. large program consisting of one or more files can  have  its
  978. dependencies  described in a _m_a_k_e_f_i_l_e which contains defini-
  979. tions of the commands used to create these  different  files
  980. when  changes  occur.  Definitions of the means for printing
  981. listings, cleaning up  the  directory  in  which  the  files
  982. reside,  and  installing  the resultant programs are easily,
  983. and most appropriately placed in this _m_a_k_e_f_i_l_e.  This format
  984. is  superior  and preferable to maintaining a group of shell
  985. procedures to maintain these files.
  986.  
  987.      Similarly when working on a document a _m_a_k_e_f_i_l_e may  be
  988. created which defines how different versions of the document
  989. are to be created and which options of _n_r_o_f_f  or  _t_r_o_f_f  are
  990. appropriate.
  991.  
  992. _3._3.  _I_n_v_o_c_a_t_i_o_n _a_n_d _t_h_e _a_r_g_v _v_a_r_i_a_b_l_e
  993.  
  994.      A _c_s_h command script may be interpreted by saying
  995.  
  996.         % csh script ...
  997.  
  998. where _s_c_r_i_p_t is the name of the file containing a  group  of
  999. _c_s_h  commands  and  `...' is replaced by a sequence of argu-
  1000. ments.  The shell places these  arguments  in  the  variable
  1001. _a_r_g_v  and  then  begins  to  read  commands from the script.
  1002. These parameters are then available through the same mechan-
  1003. isms which are used to reference any other shell variables.
  1004.  
  1005.      If you make the file `script' executable by doing
  1006.  
  1007.         chmod 755 script
  1008.  
  1009. and place a shell comment at  the  beginning  of  the  shell
  1010. script  (i.e.  begin  the  file with a `#' character) then a
  1011. `/bin/csh' will automatically be invoked to execute `script'
  1012. when you type
  1013.  
  1014.         script
  1015.  
  1016.  
  1017.  
  1018.  
  1019.                        March 11, 1984
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.                            - 2 -
  1026.  
  1027.  
  1028. If the file does not begin with  a  `#'  then  the  standard
  1029. shell `/bin/sh' will be used to execute it.  This allows you
  1030. to convert your older shell scripts to use _c_s_h at your  con-
  1031. venience.
  1032.  
  1033. _3._4.  _V_a_r_i_a_b_l_e _s_u_b_s_t_i_t_u_t_i_o_n
  1034.  
  1035.      After each input line is broken into words and  history
  1036. substitutions  are done on it, the input line is parsed into
  1037. distinct  commands.   Before  each  command  is  executed  a
  1038. mechanism  know  as  _v_a_r_i_a_b_l_e  _s_u_b_s_t_i_t_u_t_i_o_n is done on these
  1039. words.   Keyed  by  the  character  `$'  this   substitution
  1040. replaces the names of variables by their values.  Thus
  1041.  
  1042.         echo $argv
  1043.  
  1044. when placed in a command  script  would  cause  the  current
  1045. value of the variable _a_r_g_v to be echoed to the output of the
  1046. shell script.  It is an error for _a_r_g_v to be unset  at  this
  1047. point.
  1048.  
  1049.      A number of notations are provided for  accessing  com-
  1050. ponents and attributes of variables.  The notation
  1051.  
  1052.         $?name
  1053.  
  1054. expands to `1' if name is _s_e_t or to `0' if name is not  _s_e_t.
  1055. It  is  the  fundamental mechanism used for checking whether
  1056. particular variables have been assigned values.   All  other
  1057. forms of reference to undefined variables cause errors.
  1058.  
  1059.      The notation
  1060.  
  1061.         $#name
  1062.  
  1063. expands to the number of  elements  in  the  variable  _n_a_m_e.
  1064. Thus
  1065.  
  1066.         % set argv=(a b c)
  1067.         % echo $?argv
  1068.         1
  1069.         % echo $#argv
  1070.         3
  1071.         % unset argv
  1072.         % echo $?argv
  1073.         0
  1074.         % echo $argv
  1075.         Undefined variable: argv.
  1076.         %
  1077.  
  1078.  
  1079.      It is also possible to access the components of a vari-
  1080. able which has several values.  Thus
  1081.  
  1082.  
  1083.  
  1084.  
  1085.                        March 11, 1984
  1086.  
  1087.  
  1088.  
  1089.  
  1090.  
  1091.                            - 3 -
  1092.  
  1093.  
  1094.         $argv[1]
  1095.  
  1096. gives the first component of _a_r_g_v or in  the  example  above
  1097. `a'.  Similarly
  1098.  
  1099.         $argv[$#argv]
  1100.  
  1101. would give `c', and
  1102.  
  1103.         $argv[1-2]
  1104.  
  1105. would give `a b'. Other notations useful  in  shell  scripts
  1106. are
  1107.  
  1108.         $_n
  1109.  
  1110. where _n is an integer as a shorthand for
  1111.  
  1112.         $argv[_n]
  1113.  
  1114. the _n_t_h parameter and
  1115.  
  1116.         $*
  1117.  
  1118. which is a shorthand for
  1119.  
  1120.         $argv
  1121.  
  1122. The form
  1123.  
  1124.         $$
  1125.  
  1126. expands to the process number of the current  shell.   Since
  1127. this  process  number is unique in the system it can be used
  1128. in generation of unique temporary file names.  The form
  1129.  
  1130.         $<
  1131.  
  1132. is quite special and is replaced by the next line  of  input
  1133. read  from  the shell's standard input (not the script it is
  1134. reading).  This is useful for writing shell scripts that are
  1135. interactive,  reading  commands  from  the terminal, or even
  1136. writing a shell script that acts as a filter, reading  lines
  1137. from its input file. Thus the sequence
  1138.  
  1139.         echo 'yes or no?\c'
  1140.         set a=($<)
  1141.  
  1142. would write out the prompt `yes or no?'  without  a  newline
  1143. and  then  read  the  answer into the variable `a'.  In this
  1144. case `$#a' would be `0' if either a blank  line  or  end-of-
  1145. file (|^D) was typed.
  1146.  
  1147.      One minor difference between `$_n' and `$argv[_n]' should
  1148.  
  1149.  
  1150.  
  1151.                        March 11, 1984
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.                            - 4 -
  1158.  
  1159.  
  1160. be noted here.  The form `$argv[_n]' will yield an error if _n
  1161. is not in the range `1-$#argv' while `$n' will  never  yield
  1162. an  out of range subscript error.  This is for compatibility
  1163. with the way older shells handled parameters.
  1164.  
  1165.      Another important point is that it is never an error to
  1166. give  a  subrange of the form `n-'; if there are less than _n
  1167. components of the given variable then no words  are  substi-
  1168. tuted.   A range of the form `m-n' likewise returns an empty
  1169. vector without giving an error when _m exceeds the number  of
  1170. elements  of the given variable, provided the subscript _n is
  1171. in range.
  1172.  
  1173. _3._5.  _E_x_p_r_e_s_s_i_o_n_s
  1174.  
  1175.      In order for  interesting  shell  scripts  to  be  con-
  1176. structed  it must be possible to evaluate expressions in the
  1177. shell based on the values of variables.  In  fact,  all  the
  1178. arithmetic operations of the language C are available in the
  1179. shell with the same precedence that they have in C.  In par-
  1180. ticular,  the  operations  `==' and `!=' compare strings and
  1181. the operators `&&' and `||'  implement  the  boolean  and/or
  1182. operations.  The special operators `=~' and `!~' are similar
  1183. to `==' and `!=' except that the string on  the  right  side
  1184. can  have  pattern matching characters (like *, ? or []) and
  1185. the test is whether the string on the left matches the  pat-
  1186. tern on the right.
  1187.  
  1188.      The shell also allows file enquiries of the form
  1189.  
  1190.         -? filename
  1191.  
  1192. where `?' is replace by a number of single characters.   For
  1193. instance the expression primitive
  1194.  
  1195.         -e filename
  1196.  
  1197. tell whether the file `filename' exists.   Other  primitives
  1198. test for read, write and execute access to the file, whether
  1199. it is a directory, or has non-zero length.
  1200.  
  1201.      It is possible to test  whether  a  command  terminates
  1202. normally,  by  a  primitive  of the form `{ command }' which
  1203. returns true, i.e. `1' if the command succeeds exiting  nor-
  1204. mally  with  exit status 0, or `0' if the command terminates
  1205. abnormally or with exit status non-zero.  If  more  detailed
  1206. information  about  the  execution  status  of  a command is
  1207. required, it can be  executed  and  the  variable  `$status'
  1208. examined  in  the  next  command.  Since `$status' is set by
  1209. every command, it is very transient.  It can be saved if  it
  1210. is  inconvenient  to  use  it only in the single immediately
  1211. following command.
  1212.  
  1213.      For a full list of expression components available  see
  1214.  
  1215.  
  1216.  
  1217.                        March 11, 1984
  1218.  
  1219.  
  1220.  
  1221.  
  1222.  
  1223.                            - 5 -
  1224.  
  1225.  
  1226. the manual section for the shell.
  1227.  
  1228. _3._6.  _S_a_m_p_l_e _s_h_e_l_l _s_c_r_i_p_t
  1229.  
  1230.      A sample shell script which makes use of the expression
  1231. mechanism  of  the  shell  and some of its control structure
  1232. follows:
  1233.  
  1234.         % cat copyc
  1235.         #
  1236.         # Copyc copies those C programs in the specified list
  1237.         # to the directory ~/backup if they differ from the files
  1238.         # already in ~/backup
  1239.         #
  1240.         set noglob
  1241.         foreach i ($argv)
  1242.  
  1243.                 if ($i !~ *.c) continue  # not a .c file so do nothing
  1244.  
  1245.                 if (! -r ~/backup/$i:t) then
  1246.                         echo $i:t not in backup... not cp\'ed
  1247.                         continue
  1248.                 endif
  1249.  
  1250.                 cmp -s $i ~/backup/$i:t # to set $status
  1251.  
  1252.                 if ($status != 0) then
  1253.                         echo new backup of $i
  1254.                         cp $i ~/backup/$i:t
  1255.                 endif
  1256.         end
  1257.  
  1258.  
  1259.      This script makes use of  the  _f_o_r_e_a_c_h  command,  which
  1260. causes the shell to execute the commands between the _f_o_r_e_a_c_h
  1261. and the matching _e_n_d for each of the  values  given  between
  1262. `(' and `)' with the named variable, in this case `i' set to
  1263. successive values in the list.  Within this loop we may  use
  1264. the command _b_r_e_a_k to stop executing the loop and _c_o_n_t_i_n_u_e to
  1265. prematurely terminate one  iteration  and  begin  the  next.
  1266. After  the  _f_o_r_e_a_c_h  loop  the iteration variable (_i in this
  1267. case) has the value at the last iteration.
  1268.  
  1269.      We set the variable _n_o_g_l_o_b  here  to  prevent  filename
  1270. expansion  of  the members of _a_r_g_v.  This is a good idea, in
  1271. general, if the arguments to a shell  script  are  filenames
  1272. which  have  already  been  expanded or if the arguments may
  1273. contain filename expansion metacharacters.  It is also  pos-
  1274. sible  to  quote  each  use of a `$' variable expansion, but
  1275. this is harder and less reliable.
  1276.  
  1277.      The other control construct used here is a statement of
  1278. the form
  1279.  
  1280.  
  1281.  
  1282.  
  1283.                        March 11, 1984
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.                            - 6 -
  1290.  
  1291.  
  1292.         if ( expression ) then
  1293.                 command
  1294.                 ...
  1295.         endif
  1296.  
  1297. The placement of the keywords here is _n_o_t  flexible  due  to
  1298. the current implementation of the shell.
  1299.  
  1300.      The shell does have another form of the if statement of
  1301. the form
  1302.  
  1303.         if ( expression ) command
  1304.  
  1305. which can be written
  1306.  
  1307.         if ( expression ) \
  1308.                 command
  1309.  
  1310. Here we have escaped the newline for the sake of appearance.
  1311. The command must not involve `|', `&' or `;' and must not be
  1312. another control command.  The second form requires the final
  1313. `\' to _i_m_m_e_d_i_a_t_e_l_y precede the end-of-line.
  1314.  
  1315.      The more general  _i_f  statements  above  also  admit  a
  1316. sequence  of  _e_l_s_e-_i_f pairs followed by a single _e_l_s_e and an
  1317. _e_n_d_i_f, e.g.:
  1318.  
  1319.         if ( expression ) then
  1320.                 commands
  1321.         else if (expression ) then
  1322.                 commands
  1323.         ...
  1324.  
  1325.         else
  1326.                 commands
  1327.         endif
  1328.  
  1329.  
  1330.      Another important mechanism used in  shell  scripts  is
  1331. the  `:'  modifier.   We  can  use the modifier `:r' here to
  1332. __________________________
  1333. The following two formats are not currently  acceptable
  1334. to the shell:
  1335.  
  1336.      if ( expression )               # Won't work!
  1337.      then
  1338.              command
  1339.              ...
  1340.      endif
  1341.  
  1342. and
  1343.  
  1344.      if ( expression ) then command endif            # Won't work
  1345.  
  1346.  
  1347.  
  1348.  
  1349.                        March 11, 1984
  1350.  
  1351.  
  1352.  
  1353.  
  1354.  
  1355.                            - 7 -
  1356.  
  1357.  
  1358. extract a root of a filename or `:e' to extract  the  _e_x_t_e_n_-
  1359. _s_i_o_n.   Thus  if the variable _i has the value `/mnt/foo.bar'
  1360. then
  1361.  
  1362.      % echo $i $i:r $i:e
  1363.      /mnt/foo.bar /mnt/foo bar
  1364.      %
  1365.  
  1366. shows how the `:r' modifier strips off the  trailing  `.bar'
  1367. and  the  the  `:e'  modifier  leaves only the `bar'.  Other
  1368. modifiers will take off the last  component  of  a  pathname
  1369. leaving  the  head  `:h'  or all but the last component of a
  1370. pathname leaving the tail `:t'.  These modifiers  are  fully
  1371. described in the _c_s_h manual pages in the programmers manual.
  1372. It is also possible to use the _c_o_m_m_a_n_d _s_u_b_s_t_i_t_u_t_i_o_n  mechan-
  1373. ism described in the next major section to perform modifica-
  1374. tions on strings to then  reenter  the  shells  environment.
  1375. Since  each usage of this mechanism involves the creation of
  1376. a new process, it is much more expensive to use than the `:'
  1377. modification mechanism.# Finally, we note that the character
  1378. `#'  lexically  introduces  a shell comment in shell scripts
  1379. (but not from the terminal).  All subsequent  characters  on
  1380. the input line after a `#' are discarded by the shell.  This
  1381. character can be quoted using `'' or `\' to place it  in  an
  1382. argument word.
  1383.  
  1384. _3._7.  _O_t_h_e_r _c_o_n_t_r_o_l _s_t_r_u_c_t_u_r_e_s
  1385.  
  1386.      The shell also has control structures _w_h_i_l_e and  _s_w_i_t_c_h
  1387. similar to those of C.  These take the forms
  1388.  
  1389.         while ( expression )
  1390.                 commands
  1391.         end
  1392.  
  1393. and
  1394.  
  1395.  
  1396.  
  1397.  
  1398.  
  1399.  
  1400.  
  1401. __________________________
  1402. #It is also important to note that the  current  imple-
  1403. mentation  of the shell limits the number of `:' modif-
  1404. iers on a `$' substitution to 1.  Thus
  1405.  
  1406.      % echo $i $i:h:t
  1407.      /a/b/c /a/b:t
  1408.      %
  1409.  
  1410. does not do what one would expect.
  1411.  
  1412.  
  1413.  
  1414.  
  1415.                        March 11, 1984
  1416.  
  1417.  
  1418.  
  1419.  
  1420.  
  1421.                            - 8 -
  1422.  
  1423.  
  1424.         switch ( word )
  1425.  
  1426.         case str1:
  1427.                 commands
  1428.                 breaksw
  1429.  
  1430.          ...
  1431.  
  1432.         case strn:
  1433.                 commands
  1434.                 breaksw
  1435.  
  1436.         default:
  1437.                 commands
  1438.                 breaksw
  1439.  
  1440.         endsw
  1441.  
  1442. For details see the manual section for _c_s_h.   C  programmers
  1443. should  note that we use _b_r_e_a_k_s_w to exit from a _s_w_i_t_c_h while
  1444. _b_r_e_a_k exits a _w_h_i_l_e or _f_o_r_e_a_c_h loop.  A  common  mistake  to
  1445. make  in  _c_s_h scripts is to use _b_r_e_a_k rather than _b_r_e_a_k_s_w in
  1446. switches.
  1447.  
  1448.      Finally, _c_s_h allows a _g_o_t_o statement, with labels look-
  1449. ing like they do in C, i.e.:
  1450.  
  1451.         loop:
  1452.                 commands
  1453.                 goto loop
  1454.  
  1455.  
  1456. _3._8.  _S_u_p_p_l_y_i_n_g _i_n_p_u_t _t_o _c_o_m_m_a_n_d_s
  1457.  
  1458.      Commands run from shell scripts receive by default  the
  1459. standard  input  of  the  shell which is running the script.
  1460. This is different from previous shells running  under  UNIX.
  1461. It  allows  shell scripts to fully participate in pipelines,
  1462. but mandates extra notation for commands which are  to  take
  1463. inline data.
  1464.  
  1465.      Thus we need a metanotation for supplying  inline  data
  1466. to  commands in shell scripts.  As an example, consider this
  1467. script which runs the editor to delete leading  blanks  from
  1468. the lines in each argument file
  1469.  
  1470.  
  1471.  
  1472.  
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.                        March 11, 1984
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.                            - 9 -
  1488.  
  1489.  
  1490.         % cat deblank
  1491.         # deblank -- remove leading blanks
  1492.         foreach i ($argv)
  1493.         ed - $i << 'EOF'
  1494.         1,$s/|^[ ]*//
  1495.         w
  1496.         q
  1497.         'EOF'
  1498.         end
  1499.         %
  1500.  
  1501. The notation `<< 'EOF'' means that the  standard  input  for
  1502. the  _e_d command is to come from the text in the shell script
  1503. file up to the next line consisting of exactly `'EOF''.  The
  1504. fact  that  the  `EOF'  is  enclosed in `'' characters, i.e.
  1505. quoted, causes the shell to not perform  variable  substitu-
  1506. tion  on  the intervening lines.  In general, if any part of
  1507. the word following the `<<' which the  shell  uses  to  ter-
  1508. minate  the  text  to be given to the command is quoted then
  1509. these substitutions will not be  performed.   In  this  case
  1510. since  we used the form `1,$' in our editor script we needed
  1511. to insure that this `$' was not  variable  substituted.   We
  1512. could  also have insured this by preceding the `$' here with
  1513. a `\', i.e.:
  1514.  
  1515.         1,\$s/|^[ ]*//
  1516.  
  1517. but quoting the `EOF' terminator is a more reliable  way  of
  1518. achieving the same thing.
  1519.  
  1520. _3._9.  _C_a_t_c_h_i_n_g _i_n_t_e_r_r_u_p_t_s
  1521.  
  1522.      If our shell script creates  temporary  files,  we  may
  1523. wish  to  catch interruptions of the shell script so that we
  1524. can clean up these files.  We can then do
  1525.  
  1526.         onintr label
  1527.  
  1528. where _l_a_b_e_l is a label in our program.  If an  interrupt  is
  1529. received  the shell will do a `goto label' and we can remove
  1530. the temporary files and then do an _e_x_i_t  command  (which  is
  1531. built in to the shell) to exit from the shell script.  If we
  1532. wish to exit with a non-zero status we can do
  1533.  
  1534.         exit(1)
  1535.  
  1536. e.g. to exit with status `1'.
  1537.  
  1538. _3._1_0.  _W_h_a_t _e_l_s_e?
  1539.  
  1540.      There are other features of the shell useful to writers
  1541. of  shell  procedures.  The _v_e_r_b_o_s_e and _e_c_h_o options and the
  1542. related -_v and -_x command line options can be used  to  help
  1543. trace  the  actions  of the shell.  The -_n option causes the
  1544.  
  1545.  
  1546.  
  1547.                        March 11, 1984
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.                            - 10 -
  1554.  
  1555.  
  1556. shell only to read commands and not to execute them and  may
  1557. sometimes be of use.
  1558.  
  1559.      One other thing to note is that _c_s_h  will  not  execute
  1560. shell  scripts  which  do  not begin with the character `#',
  1561. that is shell scripts that do  not  begin  with  a  comment.
  1562. Similarly,  the  `/bin/sh'  on your system may well defer to
  1563. `csh' to interpret shell scripts which begin with `#'.  This
  1564. allows shell scripts for both shells to live in harmony.
  1565.  
  1566.      There is also another  quotation  mechanism  using  `"'
  1567. which  allows  only some of the expansion mechanisms we have
  1568. so far discussed to occur on the quoted string and serves to
  1569. make this string into a single word as `'' does.
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587.  
  1588.  
  1589.  
  1590.  
  1591.  
  1592.  
  1593.  
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.  
  1600.  
  1601.  
  1602.  
  1603.  
  1604.  
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.                        March 11, 1984
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.                            - 11 -
  1620.  
  1621.  
  1622.  
  1623. _4.  _O_t_h_e_r, _l_e_s_s _c_o_m_m_o_n_l_y _u_s_e_d, _s_h_e_l_l _f_e_a_t_u_r_e_s
  1624.  
  1625. _4._1.  _L_o_o_p_s _a_t _t_h_e _t_e_r_m_i_n_a_l; _v_a_r_i_a_b_l_e_s _a_s _v_e_c_t_o_r_s
  1626.  
  1627.      It is occasionally useful to use  the  _f_o_r_e_a_c_h  control
  1628. structure  at  the terminal to aid in performing a number of
  1629. similar commands.  For instance, there  were  at  one  point
  1630. three  shells  in  use on the Cory UNIX system at Cory Hall,
  1631. `/bin/sh', `/bin/nsh', and `/bin/csh'.  To count the  number
  1632. of  persons  using each shell one could have issued the com-
  1633. mands
  1634.  
  1635.         % grep -c csh$ /etc/passwd
  1636.         27
  1637.         % grep -c nsh$ /etc/passwd
  1638.         128
  1639.         % grep -c -v sh$ /etc/passwd
  1640.         430
  1641.         %
  1642.  
  1643. Since these commands are very similar we can use _f_o_r_e_a_c_h  to
  1644. do this more easily.
  1645.  
  1646.         % foreach i ('sh$' 'csh$' '-v sh$')
  1647.         ? grep -c $i /etc/passwd
  1648.         ? end
  1649.         27
  1650.         128
  1651.         430
  1652.         %
  1653.  
  1654. Note here that the shell prompts for input with  `?  '  when
  1655. reading the body of the loop.
  1656.  
  1657.      Very useful with  loops  are  variables  which  contain
  1658. lists of filenames or other words.  You can, for example, do
  1659.  
  1660.         % set a=(`ls`)
  1661.         % echo $a
  1662.         csh.n csh.rm
  1663.         % ls
  1664.         csh.n
  1665.         csh.rm
  1666.         % echo $#a
  1667.         2
  1668.         %
  1669.  
  1670. The _s_e_t command here gave the variable _a a list of  all  the
  1671. filenames  in  the  current directory as value.  We can then
  1672. iterate over these names to perform any chosen function.
  1673.  
  1674.      The output of a command within ``' characters  is  con-
  1675. verted  by the shell to a list of words.  You can also place
  1676. the ``' quoted string within `"'  characters  to  take  each
  1677.  
  1678.  
  1679.  
  1680.                        March 11, 1984
  1681.  
  1682.  
  1683.  
  1684.  
  1685.  
  1686.                            - 2 -
  1687.  
  1688.  
  1689. (non-empty)  line as a component of the variable; preventing
  1690. the lines from being split into words at blanks and tabs.  A
  1691. modifier  `:x' exists which can be used later to expand each
  1692. component of the variable into another variable splitting it
  1693. into separate words at embedded blanks and tabs.
  1694.  
  1695. _4._2.  _B_r_a_c_e_s { ... } _i_n _a_r_g_u_m_e_n_t _e_x_p_a_n_s_i_o_n
  1696.  
  1697.      Another form of filename expansion, alluded  to  before
  1698. involves  the  characters  `{'  and  `}'.   These characters
  1699. specify that the contained strings, separated by `,' are  to
  1700. be  consecutively substituted into the containing characters
  1701. and the results expanded left to right.  Thus
  1702.  
  1703.         A{str1,str2,...strn}B
  1704.  
  1705. expands to
  1706.  
  1707.         Astr1B Astr2B ... AstrnB
  1708.  
  1709. This expansion occurs before the other filename  expansions,
  1710. and  may  be applied recursively (i.e. nested).  The results
  1711. of each expanded string are sorted separately, left to right
  1712. order  being  preserved.   The  resulting  filenames are not
  1713. required to exist if no other expansion mechanisms are used.
  1714. This means that this mechanism can be used to generate argu-
  1715. ments which are not filenames, but which have common parts.
  1716.  
  1717.      A typical use of this would be
  1718.  
  1719.         mkdir ~/{hdrs,retrofit,csh}
  1720.  
  1721. to make subdirectories `hdrs', `retrofit' and `csh' in  your
  1722. home directory.  This mechanism is most useful when the com-
  1723. mon prefix is longer than in this example, i.e.
  1724.  
  1725.         chown root /usr/{ucb/{ex,edit},lib/{ex?.?*,how_ex}}
  1726.  
  1727.  
  1728. _4._3.  _C_o_m_m_a_n_d _s_u_b_s_t_i_t_u_t_i_o_n
  1729.  
  1730.      A command enclosed in ``' characters is replaced,  just
  1731. before  filenames are expanded, by the output from that com-
  1732. mand.  Thus it is possible to do
  1733.  
  1734.         set pwd=`pwd`
  1735.  
  1736. to save the current directory in the variable _p_w_d or to do
  1737.  
  1738.         ex `grep -l TRACE *.c`
  1739.  
  1740. to run the editor _e_x  supplying  as  arguments  those  files
  1741. whose  names  end  in  `.c' which have the string `TRACE' in
  1742. them.*
  1743. __________________________
  1744. *Command expansion also occurs in input redirected with
  1745.  
  1746.                        March 11, 1984
  1747.  
  1748.  
  1749.  
  1750.  
  1751.  
  1752.                            - 3 -
  1753.  
  1754.  
  1755. _4._4.  _O_t_h_e_r _d_e_t_a_i_l_s _n_o_t _c_o_v_e_r_e_d _h_e_r_e
  1756.  
  1757.      In particular circumstances it may be necessary to know
  1758. the  exact  nature and order of different substitutions per-
  1759. formed by the shell.  The exact meaning of certain  combina-
  1760. tions  of  quotations is also occasionally important.  These
  1761. are detailed fully in its manual section.
  1762.  
  1763.      The shell has a number of  command  line  option  flags
  1764. mostly  of use in writing UNIX programs, and debugging shell
  1765. scripts.  See the shells manual section for a list of  these
  1766. options.
  1767.  
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785.  
  1786.  
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794.  
  1795.  
  1796.  
  1797.  
  1798.  
  1799.  
  1800.  
  1801.  
  1802.  
  1803.  
  1804.  
  1805. __________________________
  1806. `<<'  and  within  `"'  quotations.  Refer to the shell
  1807. manual section for full details.
  1808.  
  1809.  
  1810.  
  1811.  
  1812.                        March 11, 1984
  1813.  
  1814.  
  1815.  
  1816.  
  1817. 
  1818.                            - 4 -
  1819.  
  1820.  
  1821.  
  1822. _A_p_p_e_n_d_i_x - _S_p_e_c_i_a_l _c_h_a_r_a_c_t_e_r_s
  1823.  
  1824. The following table lists the special characters of _c_s_h  and
  1825. the  UNIX system, giving for each the section(s) in which it
  1826. is discussed.  A number of these characters also  have  spe-
  1827. cial meaning in expressions.  See the _c_s_h manual section for
  1828. a complete list.
  1829.  
  1830. Syntactic metacharacters
  1831.  
  1832.         ;       2.4     separates commands to be executed sequentially
  1833.         |       1.5     separates commands in a pipeline
  1834.         ( )     2.2,3.6 brackets expressions and variable values
  1835.         &       2.5     follows commands to be executed without waiting for completion
  1836.  
  1837.  
  1838. Filename metacharacters
  1839.  
  1840.         /       1.6     separates components of a file's pathname
  1841.         ?       1.6     expansion character matching any single character
  1842.         *       1.6     expansion character matching any sequence of characters
  1843.         [ ]     1.6     expansion sequence matching any single character from a set
  1844.         ~       1.6     used at the beginning of a filename to indicate home directories
  1845.         { }     4.2     used to specify groups of arguments with common parts
  1846.  
  1847.  
  1848. Quotation metacharacters
  1849.  
  1850.         \       1.7     prevents meta-meaning of following single character
  1851.         '       1.7     prevents meta-meaning of a group of characters
  1852.         "       4.3     like ', but allows variable and command expansion
  1853.  
  1854.  
  1855. Input/output metacharacters
  1856.  
  1857.         <       1.5     indicates redirected input
  1858.         >       1.3     indicates redirected output
  1859.  
  1860.  
  1861. Expansion/substitution metacharacters
  1862.  
  1863.         $       3.4     indicates variable substitution
  1864.         !       2.3     indicates history substitution
  1865.         :       3.6     precedes substitution modifiers
  1866.         |^       2.3     used in special forms of history substitution
  1867.         `       4.3     indicates command substitution
  1868.  
  1869.  
  1870. Other metacharacters
  1871.  
  1872.         #       1.3,3.6 begins scratch file names; indicates shell comments
  1873.         -       1.2     prefixes option (flag) arguments to commands
  1874.         %       2.6     prefixes job