armidale command line programs

The following armidale programs are included in the armidale system. In order to run each of the following programs the armidale.jar file must be on Java's classpath. This can be done by using the -cp <classpath> switch with the java command or by setting the CLASSPATH environment variable.

The armidale launcher

The following command will start the armidale launcher. See Using the armidale launcher for more information.

java armidale.api.launcher

The armidale server

The following command will start the armidale server.

java armidale.api.Server [-port <port_number>] [-[new]log <filename>]


-port <port_num> specifies the port number the server will listen on for client connections. If no port is specified, the server will listen on port 3000.

-log <filename> or -newlog <filename> tells the server to append all messages to the specified file rather than the screen. If -newlog is used, a new log file is created.

Remote Application

The following command line can be used on a client computer to start an armidale application on an armidale server.

java armidale.api.RemoteApplication <url> {<argument>}


<url> specifies the URL of the application to start. The syntax of the URL is described here.

{<argument>} specifies zero or more arguments to be passed to the application started on the server.

GUI Widget class code generator

The following command is used to generate the Java source code for classes that implement a set of GUI Widgets.

java armidale.utilities.makeclass.Main {<spec_filename>} -platforms <platform_list> -classid (<id> | <filename>) [-source <directory>] [-norestore]


{<spec_filename>} specifies one or more XML files that describe the widgets to be generated.

-platforms <platform_list> specifies the list of platforms for which to generate platform implementation classes. <platform_list> is a list of platform names separated by ":". For example "-platforms swing" or "-platforms swing:swt".

-classid <filename> | <ID>. All armidale widgets have a unique ID. This switch is used to specify the ID of the widget. If a filename is specified, the class ID will be extracted from a list of classes and IDs in the file (see developer/src/armidale/api/gui/xml/widget.txt for an example). If an ID is specified, it will be used for the class ID.

If you want to develop your own widgets, you will need a set of unique class IDs. For now, we will allocate IDs manually. If you want some ID's please email