• Synopsis
• Usage
• Configuring the nsh
  
  

${SORCER_HOME}/bin/shell/bin/nsh [-f <filename>] [options] | [--<application name> | [options] 

commands
    -f <filename> [options]
    Execute the netlet (a mogram in the Service Modelinng Language (SML)) specified by the file <filename>.
    The shenbang synatx, e.g., #!/path/to/nsh -f can be used directly in executable SML scripts.
    
    --<application name> | [options]
    Start a default or custom application, tool or utility. 

    Default nsh application names:
      blitz     Start a Blitz JavaSpaces
      browser   Start a  SORCER service browser
      cataloger Start a SORCER service catalog
      emx       Start a SORCER Exert Monitoring service
      jini      Start Jini basic services
      jobber    Start a SORCER Jobber (a push rendezvous service)
      locker    Start a SORCER service lock manager
      logger    Start a SORCER logging service
      mmx       Start a SORCER Model Monitoring service
      sos       Start basic SORCER operating system services
      spacer    Start a SORCER Spacer (a pull rendezvous service)
      webster   Start a  standalone code server (webster)
      
 
   For defining custom applications see: Configuring the nsf shell below.


	groups=group1,group2,...        Comma separated names of multicast groups to
    					discover. If "all" is provided, this will be
                        		translated to DiscoveryGroupManagment.ALL_GROUPS
          
	locators=jini://host[:port]     Comma separated names of lookup locators to discover
          
	discoveryTimeout=millis         Discovery timeout (in milliseconds)
 
	httpPort=port                   Port to use when starting Webster files

	roots=root1,root2,...		Root directories for Webster

	jars=jar1,jar2,...              Exported classes by this shell (codebase)

	-noHttp				Do not start Webster, mutually exclusive
					with the httpPort option

	<file name>.config              An overriding configuratin file for this shell
 
          

You can manage and interact with the SORCER network using the following commands:

	cd: 		cd <directory name> | ~
	chgrp: 		chgrp <groups> | chgrp -r <registrar index> <groups>
	chport: 	chport <lookup service index> port
	clear: 		clear -a | -p | -m | -e
	dir: 		dir [-l]
	disco: 		disco [<registrar index> | -v]
	edit: 		edit [<filename>]
	exert: 		exert [-cc] [[-s | --s | --m] <output filename>] <input filename>
  	groups: 	groups [-d]
	gvy: 		gvy <input filename> [-s <output filename>]
	help: 		help &ld;command> | ? 
	http: 		http [port=<port-num>] [roots=<http roots>] [jars=<http jars>] | stop
	ig: 		ig -h | -n
	info: 		info [-a]
	ls: 		ls [-l]
	lup: 		lup  [-s | -p | <service index> | -v | -x] | --d <service index>
			      | ( -p | -s ) [-n <name attribute value>] [-i <service type name>] 
	mxe: 		mxe [-m | -m <EMX index> | -v | -x]
			      | [ -a | -d | -f | -r | -y | <exertion index>] 
			      | (-e | -c | -cc | -ccc) [<exertion index>] [-s <filename>]
	pwd: 		pwd
	start: 		start <application name>
	stop: 		stop <lookup service index> | all

For help on any of these commands type 'help [<command>]'.
To leave this program type 'quit'

Environment

disco

lup  

start  

stop  

edit

exert

help

http  

mxe  

mxm  

!!

Configuring the nsh shell
The nsh shell startup script can be specifued by the environmt variable NSH_STARTUP or by $HOME/.nsh/startup.

User defined classes for the shell can be specified by the environment variable CLASSPATH or in a shell start configuration. The nsh start configuration file can be specified by the environmt variable NSH_CONF or by $HOME/.nsh/configs/nsh-start.config; the default file is $SORCER_HOME/bin/shell/configs/nsh-start.config.

The default shell initialization file $SORCER_HOME/bin/shell/configs/nsh-init.config is used if present. Alternatively an initialization file (with the config extention) can be passed as the first argument to the nsh or placed in $HOME/.nsh/configs. The nsh initialization file supports the following configuration entries, with component sorcer.tools.shell.NetworkShell.

• applications

  Type:	String[]
  Default:	new String[] { "browser", "browser/bin/service-browser-run.xml", ... };
  Description:	This entry will be read at initialization by the nsh shell to determine the initial set of related applications (for each application its name and path).

• groups

  Type:	String[]
  Default:	{@link net.jini.discovery.DiscoveryGroupManagement#ALL_GROUPS}
  Description:	This entry will be read at initialization by the nsh shell to determine the initial set of multicast discovery groups the nsh should participate in.

• httpPort

  Type:	int
  Default:	0
  Description:	The port that Webster should be started with. Using the default port (0), Webster is started with an anononous port

• httpRoots

  Type:	String[]
  Default:	new String [] { "$SORCER_HOME/lib/sorcer/lib-dl", "$SORCER_HOME/lib/river/lib-dl", $SORCER_HOME/lib/rio/lib-dl" }
  Description:	An array documenting the directories to serve code from.



• httpJars

  Type:	String[]
  Default:	new String [] { }
  Description:	An array documenting the classes to be exported from jar files (codebase).

• locators

  Type:	{@link net.jini.core.discovery.LookupLocator}[]
  Default:	null
  Description:	This entry will be read at initialization by the nsh shell to determine the initial set of specific lookup services the nsh should register with.

• noHttp

  Type:	boolean
  Default:	false
  Description:	The entry is read at startup, if set to true, then a Webster instance will not be created by the nsh shell. Not that this entry renders the httpPort and httpRoot entries useless

  
  
• logDir

  Type:	String
  Default:	$SORCER_HOME/bin/shell/logs
  Description:	The entry is read at startup to create the shell log file for System.err when the shell is noninteractive.