Process Nicknames: nickname
Keywords: userguide

Next: ODT Derived Quantity Calculator: Up: Command Line Utilities Previous: MIF Format Conversion: mifconvert

##
Process Nicknames: nickname

The nickname command associates nicknames to running instances of OOMMF applications. These names are used by the MIF 2.x `Destination` command.

Launching
The nickname command line is:

    tclsh oommf.tcl nickname [standard options] [-account name] \
       [-hostport port] [-pid] [-timeout secs] oid nickname [nickname2 ...]

where

`-account name`
  Specify the account name. The default is the same used by mmLaunch: the current user login name, except on Windows 9X, where the dummy account ID ``oommf'' may be used instead.
`-hostport port`
  Use the host server listening on `port`. Default is set by the `Net_Host port` setting in `oommf/config/options.tcl`, or by the environment variable `OOMMF_HOSTPORT` (which, if set, overrides the former). The standard setting is 15136.
`-pid`
  Specify application instance to nickname by system PID (process identifier) rather than OID (OOMMF identifier).
`-timeout secs`
  Maximum time to wait for response from servers, in seconds. Default is five seconds.
`oid`
  The OOMMF ID of the running application instance to nickname, unless the `-pid` option is specified, in which case the system PID is specified instead.
`nickname`
  One or more nicknames to associate with the specified application instance. Each nickname must include at least one non-numeric character.

This command is used to associate nicknames with running instances of OOMMF applications. The MIF 2 `Destination` command can then use the nickname to link Oxs output to a given OOMMF application instance at problem load time. Nicknames for GUI applications can be viewed in the application `About` dialog box, or can be seen for any application via the `-names` option to the command line application pidinfo.

Note that nicknames can also be associated with OOMMF applications when they are started via the standard `-nickname` command line option, or by using the `application:nickname` syntax for applications launched by the MIF `Destination` command.

OOMMF Documentation Team
September 29, 2018