metaonly module xdc.tools.path.sg.Main
index URL

Command implementation

This graphical interactive tool displays the packages located along any specified package repository path. [ more ... ]
XDCscript usage meta-domain sourced in xdc/tools/path/sg/Main.xdc
var Main = xdc.useModule('xdc.tools.path.sg.Main');
module-wide config parameters
    Main.usage// Usage for this command = String[] [
        '[--packagepath PATH]'
    ];
module-wide functions
    Main.exec// 'xs' script entry point(Any args) returns Any
    Main.main// 'xs' shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.pathArg// package path to scan for packages = String null;
per-instance functions
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
USAGE
    xs xdc.tools.path.sg [--packagepath PATH]
DETAILS
This graphical interactive tool displays the packages located along any specified package repository path.
At startup, this tool shows the packages located along the current package path; i.e.,
      $XDCPATH;$XDCROOT/packages;^
where $XDCPATH is the value of the the user settable prefix of the package path, $XDCROOT is the installation directory of the XDC tools, and ^ is the repository of the package in the current working directory (if it exists). To specify a package path other than the current package path, use the --packagepath option. Only semicolon delimited canonical paths should be specifed as arguments with the --packagepath option. Environment variables such as $XDCROOT and special designators such as '^' should not be used.
BUGS
This tool scans all packages available along the current package path before displaying the user interface. So, a repository in the package path that contains a large number of sub-directories, such as '/', causes very long delays before the user interface is displayed.
While it is easy to see that you should not put '/' in the package path, it is less obvious that installing a package at '/' has the same effect.
 
config Main.usage  // module-wide
index URL

Usage for this command

XDCscript usage meta-domain
Main.usage = String[] [
    '[--packagepath PATH]'
];
 
 
Main.exec()  // module-wide
index URL

'xs' script entry point

XDCscript usage meta-domain
Main.exec(Any args) returns Any
 
 
Main.main()  // module-wide
index URL

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
 
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.pathArg = String null;
    // package path to scan for packages
 
config Main.pathArg  // instance
index URL

package path to scan for packages

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.pathArg = String null;
 
 
Main.run()  // instance
index URL

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
 
generated on Thu, 27 Sep 2012 23:21:15 GMT