NAME

sysinfo - return host name and user name, working directory and IRAF version as parameters

USAGE

sysinfo

PARAMETERS

(host) [string]

Parameter returning the name of the host machine

(arch) [string]

Parameter returning the host machine architecture

(userid) [string]

Parameter returning the user id (login name)

(username) [string]

Parameter returning the full user name

(path) [string]

Parameter returning the path to the current working directory

(origin) [string]

Parameter returning the origin of the IRAF distribution running on 'host'

(version) [string]

Parameter returning the IRAF version running on 'host'

(sysmsg) [string]

Parameter returning a composite of 'host', 'user' and 'version' suitable to write to a text log file.

DESCRIPTION

Simple task returning the name and architecture of the host machine, the user name and the host system path to the current working directory, as well as the version of IRAF that is running on the host machine. This task is useful for generating opening messages and time stamps in a text log file in conjunction with 'gdate'. The generic format of composite message 'sysmsg' is: "'version' 'user'@'host'"

Note that in order for the returned 'username' to be non-empty, the user needs to add a line to the default 'login.cl' file, e.g., directly following the line defining the 'userid' (in fact, it may be a copy of that line):

    set     userid          = "jdoh"
    set     username        = "John/Jane D'Oh"

EXAMPLES

1. Generate an opening message in a text log file (from within a script):

    sysinfo() ; gdate(utc=yes)
    print ("# WFPCSTACK: "//sysinfo.sysmsg//"  "//gdate.adate//" UTC",
        >> logfile)

which might result in the following message being logged to 'logfile':

# WFPCSTACK: IRAF2.12.1  raj@hasnap  Wed 05-Dec-2003 00:57:29 UTC

2. To show the information that sysinfo has collected:

    rj> sysinfo()
    rj> lpar sysinfo
        (host = "hasnap")       Host system name
        (arch = "redhat")       Host system architecture
      (userid = "raj")          User id (short)
    (username = "R.A. Jansen")  User name (full)
        (path = "/data2/raj/red/") Current working directory
      (origin = "NOAO/IRAF")    Origin of IRAF distribtion
     (version = "V2.12.2-EXPORT") Version of IRAF running on host
      (sysmsg = "IRAF2.12.2  raj@hasnap") Composite message for logging
        (mode = "ql")

REVISIONS

SYSINFO v2.10, Jul 5 1997 [R.A. Jansen]

Original version of this task; IRAF 2.10.4

SYSINFO v2.12, Aug 5 2003 [RAJ]

Cleaned up code a bit, added 'sysmsg', and wrote this help file; IRAF 2.12.1

SYSINFO v2.12, Apr 25 2004 [RAJ]

Added 'arch' and 'origin' parameters; IRAF 2.12.2

BUGS

SEE ALSO

cparse, scan, envget, gdate