functions
NAME
system --- issue a shell command
SYNTAX
exitcode = system(cmdstr)
exitcode = system(cmdstr, stdout_str)
DESCRIPTION
Executes cmdstr as though it had been typed as
command to a unix shell from the terminal. HOC waits until the command is
completed. If the second strdef arg is present, it receives the stdout stream
from the command. Only available memory limits the line length and
number of lines.
EXAMPLES
-
system("ls")
- Prints a directory listing in the console terminal window.
will take up where it left off when the user types the
exit
command
BUGS
Fully functional on unix, mswin under cygwin, and mac osx.
Does not work on the mac os 9 version.
Following is obsolete:
Under mswin, executes the string under the cygwin sh.exe in $NEURONHOME/bin
via the wrapper, $NEURONHOME/lib/nrnsys.sh . Normally, stdout is directed to
the file tmpdos2.tmp in the working directory and this is copied to the
terminal. The neuron.exe busy waits until the nrnsys.sh script creates
a tmpdos1.tmp file signaling that the system command has completed.
Redirection of stdout to a file can only be done with the idiom
"command > filename". No other redirection is possible except by modifying
nrnsys.sh .
functions
NAME
startsw, stopsw --- stopwatch
SYNTAX
startsw()
stopsw()
DESCRIPTION
Startsw() initializes the stopwatch. Stopsw() returns the number of
seconds since the previous startsw().
functions
NAME
neuronhome -- installation path
SYNTAX
string = neuronhome()
DESCRIPTION
Returns the full installation path in unix format or, if it exists, the
NEUROHOME environment variable in unix format.
Note that for unix, it isn't exactly the installation path
but the
--prefix/share/nrn directory where --prefix is the
location specified during installation. For the mswin version it is the location
selected during installation and the value is derived from the location
of neuron.exe in neuronhome()/bin/neuron.exe.
For mac it is the folder that contains the neuron
executable program.
functions
SYNTAX
show_winio(0or1)
DESCRIPTION
MSWin and Mac version only. Hides or shows the console window.
BUGS
This function no longer does anything. It was useful long ago for windows
3, 95, Mac OS 9, and before when the console terminal was a part of the
neuron executable. Since Cygwin, MinGW, and OS X, the executable is typically
launched from an existing terminal window (rxvt for Cygwin, console from
MinGW, Terminal from OS X) which handles stdio in the same way as the linux
version. The nrniv executable can be launched from another program besides
a terminal and will work if stdin, stdout, and stderr are directed
properly.
functions
SYNTAX
WinExec("mswin command")
DESCRIPTION
MSWin version only.
functions
SYNTAX
type = unix_mac_pc()
DESCRIPTION
Return 1 if unix, 2 if mac, 3 if mswin, or 4 if mac osx darwin
is the operating system. This
is useful when deciding if a machine specific function can be called or
a dll can be loaded.
functions
SYNTAX
nrn_load_dll(dll_file_name)
DESCRIPTION
Loads a dll containing membrane mechanisms. This works for mswin, mac,
and linux.
functions
SYNTAX
versionstring = nrnversion()
string = nrnversion(i)
DESCRIPTION
Returns a string consisting of version information.
When this function was introduced the majorstring was "5.6"
and the branch string was "2004/01/22 Main (36)".
Now the arg can range from 0 to 6. The value of 6 returns
the args passed to configure. When this function was last changed
the return values were
oc>nrnversion()
NEURON -- VERSION 7.1 (296:ff4976021aae) 2009-02-27
oc>for i=0,6 print i,": ", nrnversion(i)
0 : 7.1
1 : NEURON -- VERSION 7.1 (296:ff4976021aae) 2009-02-27
2 : VERSION 7.1 (296:ff4976021aae)
3 : ff4976021aae
4 : 2009-02-27
5 : 296
6 : '--prefix=/home/hines/neuron/nrnmpi' '--srcdir=../nrn' '--with-paranrn' '--with-nrnpython'
oc>
BUGS
An arg of 7 now returns a space separated string of the arguments used
during launch.
e.g.
$ nrniv -nobanner -c 'nrnversion()' -c 'nrnversion(7)'
NEURON -- VERSION 7.2 twophase_multisend (534:2160ccb31406) 2010-12-09
nrniv -nobanner -c nrnversion() -c nrnversion(7)
$
neuron/general/function/system.hel : Dec 31 08:30