Information on the Current S-PLUS

DESCRIPTION:

Various items of information about the currently running S-PLUS are collected and returned as a list. This information may be useful when reporting problems.

USAGE:

info(Sinfo=T, Xinfo=F, Xlist=list(), file=tempfile("info."),  
     append=F) 

OPTIONAL ARGUMENTS:

Sinfo
logical flag: if TRUE, the standard S-PLUS information is collected.
Xinfo
logical flag: if TRUE, information pertaining to X11 is included.
Xlist
a list of class Xinfo. If it is supplied, and Xinfo is TRUE, then the X11 information is taken from this list and is not prompted for. A suitable list is available from the Xinfo component of the list produced in a previous call to info with argument Xinfo=TRUE.
file
filename on which the output should be saved. If not supplied, a temporary filename is generated and used. To suppress saving of output altogether, specify file="".
append
logical flag: if TRUE, the output is appended on file. Useful if file contains other S-PLUS output and info is used to stamp this.

VALUE:

A list with component Sinfo, and component Xinfo if argument Xinfo is TRUE.

Sinfo is a list of class Sinfo with the following components:

version
a list of class Sversion, containing information about this release of S-PLUS. See the dataset named version.
hostname
character string containing the system's host name.
SHOME
character string containing the path of the S-PLUS top directory.
prog.name
character string containing the path of the S-PLUS main executable.
process.id
list with components pid and ppid, containing the process id number of the main S-PLUS process and of its parent process. These objects are numeric.
load.date
character string containing the date when this version of S-PLUS was built.
date
character string containing the current date.

Xinfo is a list of class Xinfo with the following components:

S.machine
name of host on which S-PLUS is running. This is normally the same as component hostname of Sinfo.
server.where
character string specifying where the X11 server is running (machinename, displaynumber, screennumber). This normally coincides with environment variable DISPLAY.
server.specrel
character string containing the X11 server specification release.
gui
character string specifying the graphical user interface.
wmgr.which
character string specifying the name of the window manager.
wmgr.where
character string specifying on what host machine the window manager is running.
wmgr.version
character string specifying the version of the window manager.

SIDE EFFECTS:

If file != "", a file is created and written with the output of info.

DETAILS:

info might be used to stamp a collection of results with information about the version of S-PLUS which created these. It would also provide useful details when reporting a problem.

SEE ALSO:

, , , , .

EXAMPLES:

 # Collect S-PLUS information, suppress X11 information. 
 # This example was produced on a Sun-4 workstation. 
  info(Xinfo=F) 
S info saved in /tmp/info.25309 
$Sinfo: 
Version 3.1 Release 1 for Sun SPARC, SunOs 4.x : 1992 
hostname:                        cassandra 
SHOME:                           /usr/splus 
prog.name:                       /usr/splus/cmd/Sqpe 
process.id:                      pid: 18803     ppid: 12404 
load.date:                       Fri Sep  6 09:56:59 PDT 1991 
date:                            Sat Sep  7 15:51:49 PDT 1991 
 # Assuming the following X11 information never changes,  
 # make a list which we can re-use every time we call 
<CODE>info</CODE>: 
  my.permanent.Xinfo <- info(Xinfo=T, file="")$Xinfo 
Machine on which you are running S-PLUS: [cassandra] : 
Machine on which X-server is running: [ophelia:0.0] : 
X specification release of this X server: [X11-R4] : 
G. U. I. (X11, Motif, OpenLook): [X11] : OpenLook 
Which window manager are you running: [twm] : 
Machine on which it is running: [<unknown>] : cordelia 
Version of window manager: [<unknown>] : 
 # Use it: 
  info(Xinfo=T, Xlist=my.permanent.Xinfo)