*** empty log message ***
[ess.git] / doc / README.SPLUS4COMMAND
blobc2bd6a356e7fb2f1db7d1cf57aa7c44eacf4775d
1 I finally got the S-Plus 4.x Commands window to appear in the *S+4*
2 buffer.
4   http://astro.ocis.temple.edu/~rmh/essd-sp4com.el
6 There are four functions in the file essd-sp4com.el.
8 1.  The primary user command is `M-x S+4-command'.  This starts up the
9 S-Plus GUI and sinks the output from the Commands window to the *S+4*
10 buffer.  The user then enters commands in the buffer myfile.s, sends
11 them to S-Plus with C-c C-n and reads S output in the *S+4* buffer.
13 `S+4-command' works by using the file S-transcript.st in the current
14 directory as a communication file.  S-Plus sinks its output to that
15 file.  *S+4* uses 'tail -f' to read the file.  The author of tail was
16 very clever.  The ls or dir of the file S-transcript.st shows it to
17 have 0 bytes.  Windows does not place a positive byte count on it
18 until after the file is closed by the process writing to it.  tail
19 sneaks around the back and manages to read the file contents from the
20 cache where it lives before the file is closed.
22 2.  The second user command is `M-x S+4-tail'.  S+4-command calls
23 S+4-tail, so the user may not need to call it directly.  S+4-tail asks
24 the user for permission to delete the previous instance of
25 S-transcript.st.  You must say yes to continue.  Should you say no,
26 you will be given the opportunity to rename the file and then continue
27 by re-issuing the command `M-x S+4-tail'.
30 The internal functions are:
32 3. `ess-mark-pop-up' is based on `dired-mark-pop-up'.  It is used to
33 query you about deleting the file.
35 4.`S+4-command-startup' is almost identical to `S+4'.  The only real
36 difference is that it starts S-Plus with the "&" and `S+4' does not
37 use the "&".
40 ;;; The advantages:
41 ;;;  * S text output is in an emacs buffer and therefore searchable
42 ;;;    using emacs commands.
43 ;;;  * All GUI graphics and buttons are accessible.
44 ;;;
45 ;;; The characteristics of this version of the ESS interface:
46 ;;;  * We can't type in the *S+4* buffer.
47 ;;;  * Prompts do NOT appear in the *S+4* buffer.
48 ;;;  * All error messages appear only in the S-Plus Commands window,
49 ;;;    NOT in the *S+4* buffer.
50 ;;;  * We can type in the S-Plus Commands window, but no results
51 ;;;    appear there, all results appear in the *S+4* buffer.
52 ;;;  * Echoed input is reformatted by S-Plus.