A.2 "acuconnect" Command Formats

When entered with no options, acuconnect displays a list of options.

Usage:

acuconnect
acuconnect  -access
acuconnect  -info [-p portnum]
acuconnect  -install [-p portnum] *
acuconnect  -kill [-p portnum] [-f]
acuconnect  -remove [-p portnum] *
acuconnect  -start [-p portnum] [-c config_file] [-d] [-l]
[-e error_file] [-f] [-t#]
acuconnect  -version

* available only on Windows NT and Windows 2000 servers

Command option Description and usage
-access Starts the server access file manager utility. The access file manager is used to create and maintain the database of authorized AcuConnect clients and users. To use "-access" you must be logged onto a UNIX server as root or superuser or onto a Windows NT or Windows 2000 server from the Administrator account or from an account that belongs to the Administrators group. For a description of this tool, see Chapter 3.
-info This option tells you whether or not acuconnect is running on the specified port.

There is one optional argument to "-info":

-p portnum

If you want to know if acuconnect is running on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-install This option is for Windows NT and Windows 2000 servers only. It installs AcuConnect as a Windows service.

There is one optional argument to "-install":

-p portnum

If you want to install acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-kill Causes the acuconnect process to be halted (killed). If no portnum is specified, the acuconnect process is halted on the default port (6996); otherwise the process is halted on the named port.

To use "-kill" you must be logged onto a UNIX server as root or superuser or onto a Windows NT or Windows 2000 server from the Administrator account or from an account that belongs to the Administrators group.

acuconnect attempts to close all open files before shutting down.

Unless the "-f" option is specified, acuconnect prompts for confirmation before the halt action is executed.

Shutting down acuconnect on: condor There are 0 files in use by acuconnect on: condor Do you really want to shut down acuconnect [N]?

Respond by entering "Y" or "N".
There are two optional arguments to "-kill": "-f" and "-p".
"-f" causes the acuconnect process to terminate immediately, without prompting for confirmation. "-f" should be used when "acuconnect -kill" is included in a program or script.
"-p portnum" specifies which port to terminate. If you want to terminate acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
The acuconnect process can also be terminated from the command line. For example, on UNIX you could use the command "kill -9" (signal #9). However, a signal #9 prevents acuconnect from performing an orderly shutdown and should never be used when clients are actively using AcuConnect.
Under Windows NT and Windows 2000, you can use the command "sc stop AcuConnect", or you can use the AcuConnect icon titled "Stop AcuConnect Service".
-remove This option is for Windows NT and Windows 2000 servers only. It shuts down AcuConnect (if it is not already shut down) and removes the Windows service for AcuConnect.
There is one optional argument to "-remove":
-p portnum
If you want to remove acuconnect running on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-start Causes acuconnect to be started. On Windows NT and Windows 2000 servers, this option also installs AcuConnect as a Windows service, if it is not already installed.
To use "-start" on a UNIX server, you must be logged in as root or superuser. On a Windows NT or Windows 2000 server, you must use "-start" from the Administrator account or from an account that belongs to the Administrators group.
acuconnect is started in the background unless the "-f" option is specified. If acuconnect is already running, AcuConnect will output the message:
acuconnect is already running on hostname
A new acuconnect process will not be started. If you want to start AcuConnect with new options, you must stop and restart acuconnect.

Optional arguments to "-start" include:
-c Specifies the name and path of the server configuration file. The "-c" must be followed by a space, and then the path and name of the server configuration file. When "-c" is not used, acuconnect looks for the configuration file in its default location: "/etc/server.cfg" for UNIX or "\etc\server.cfg" for Windows NT and Windows 2000.
-d Enables the remote application to be run in debug mode. When started in debug mode, the AcuConnect server runs in the foreground, and any or all remote programs are displayed in the debugger. This behavior is independent of any settings on the client.
-e Causes error output from acuconnect to be appended to the named file. The "-e" must be followed by a space and the path and name of the error output file.

If "-e" is not specified, acuconnect will attempt to direct error output to /dev/console. If /dev/console cannot be opened, acuconnect will attempt to append to a file named acuconnect.err in the current directory. If that file doesn't exist, or the file append fails, acuconnect will print the message "acuconnect: can't open error output file" to standard output, and acuconnect will terminate.
-f By default, acuconnect runs in background. Use the "-f" option to run acuconnect in foreground. When run in foreground, the acuconnect process traps normal keyboard signals, such as Control-C.

If combined with the "-t" option, the "-f" option causes acuconnect to display tracing and transaction messages directly to the screen. However, if the "-e" switch is used, all messages are placed in the named log file.
-l Causes a listing of the server configuration file to be printed to standard error output. This can be helpful when you are debugging problems that may be related to configuration variables. When "-l" is combined with the "-e" option, the listing is captured in the error output file.
-p portnum If you want to start acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-t# Turns on file tracing and transaction logging and sets the trace level. When combined with the "-e" option, file trace and transaction messages are placed in the named error file. Valid options are "1", "2", and "3". The default is "1".

"-t1" causes a message to be printed to standard output every time a file operation is performed. The message includes: the type of operation performed, the name of the target file or file ID, and the values of any applicable keys.

"-t2" causes acuconnect to produce a message whenever a connection request is made or a disconnect is performed. It also outputs a message whenever an "acuconnect -kill" command is processed.

"-t3" causes both level 1 and level 2 messages to be output. Values other than 1, 2, or 3, including null, are treated as 1.
-version Causes the version number of acuconnect to be output. "-version" must be the only argument on the command line. You should run this command from the directory where you started AcuConnect.

Command option	Description and usage
-access	Starts the server access file manager utility. The access file manager is used to create and maintain the database of authorized AcuConnect clients and users. To use "-access" you must be logged onto a UNIX server as root or superuser or onto a Windows NT or Windows 2000 server from the Administrator account or from an account that belongs to the Administrators group. For a description of this tool, see Chapter 3.
-info	This option tells you whether or not acuconnect is running on the specified port. There is one optional argument to "-info": -p portnum If you want to know if acuconnect is running on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-install	This option is for Windows NT and Windows 2000 servers only. It installs AcuConnect as a Windows service. There is one optional argument to "-install": -p portnum If you want to install acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-kill	Causes the acuconnect process to be halted (killed). If no portnum is specified, the acuconnect process is halted on the default port (6996); otherwise the process is halted on the named port. To use "-kill" you must be logged onto a UNIX server as root or superuser or onto a Windows NT or Windows 2000 server from the Administrator account or from an account that belongs to the Administrators group. acuconnect attempts to close all open files before shutting down. Unless the "-f" option is specified, acuconnect prompts for confirmation before the halt action is executed. `Shutting down acuconnect on: condor There are 0 files in use by acuconnect on: condor Do you really want to shut down acuconnect [N]?` Respond by entering "Y" or "N". There are two optional arguments to "-kill": "-f" and "-p". "-f" causes the acuconnect process to terminate immediately, without prompting for confirmation. "-f" should be used when "acuconnect -kill" is included in a program or script. "-p portnum" specifies which port to terminate. If you want to terminate acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number. The acuconnect process can also be terminated from the command line. For example, on UNIX you could use the command "kill -9" (signal #9). However, a signal #9 prevents acuconnect from performing an orderly shutdown and should never be used when clients are actively using AcuConnect. Under Windows NT and Windows 2000, you can use the command "sc stop AcuConnect", or you can use the AcuConnect icon titled "Stop AcuConnect Service".
-remove	This option is for Windows NT and Windows 2000 servers only. It shuts down AcuConnect (if it is not already shut down) and removes the Windows service for AcuConnect. There is one optional argument to "-remove": -p portnum If you want to remove acuconnect running on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-start	Causes acuconnect to be started. On Windows NT and Windows 2000 servers, this option also installs AcuConnect as a Windows service, if it is not already installed. To use "-start" on a UNIX server, you must be logged in as root or superuser. On a Windows NT or Windows 2000 server, you must use "-start" from the Administrator account or from an account that belongs to the Administrators group. acuconnect is started in the background unless the "-f" option is specified. If acuconnect is already running, AcuConnect will output the message: `acuconnect is already running on hostname` A new acuconnect process will not be started. If you want to start AcuConnect with new options, you must stop and restart acuconnect. Optional arguments to "-start" include:
-c	Specifies the name and path of the server configuration file. The "-c" must be followed by a space, and then the path and name of the server configuration file. When "-c" is not used, acuconnect looks for the configuration file in its default location: "/etc/server.cfg" for UNIX or "\etc\server.cfg" for Windows NT and Windows 2000.
-d	Enables the remote application to be run in debug mode. When started in debug mode, the AcuConnect server runs in the foreground, and any or all remote programs are displayed in the debugger. This behavior is independent of any settings on the client.
-e	Causes error output from acuconnect to be appended to the named file. The "-e" must be followed by a space and the path and name of the error output file. If "-e" is not specified, acuconnect will attempt to direct error output to /dev/console. If /dev/console cannot be opened, acuconnect will attempt to append to a file named acuconnect.err in the current directory. If that file doesn't exist, or the file append fails, acuconnect will print the message "acuconnect: can't open error output file" to standard output, and acuconnect will terminate.
-f	By default, acuconnect runs in background. Use the "-f" option to run acuconnect in foreground. When run in foreground, the acuconnect process traps normal keyboard signals, such as Control-C. If combined with the "-t" option, the "-f" option causes acuconnect to display tracing and transaction messages directly to the screen. However, if the "-e" switch is used, all messages are placed in the named log file.
-l	Causes a listing of the server configuration file to be printed to standard error output. This can be helpful when you are debugging problems that may be related to configuration variables. When "-l" is combined with the "-e" option, the listing is captured in the error output file.
-p portnum	If you want to start acuconnect on a port other than the default (6996), be sure to include "-p" followed by a space, and then the exact port number.
-t#	Turns on file tracing and transaction logging and sets the trace level. When combined with the "-e" option, file trace and transaction messages are placed in the named error file. Valid options are "1", "2", and "3". The default is "1". "-t1" causes a message to be printed to standard output every time a file operation is performed. The message includes: the type of operation performed, the name of the target file or file ID, and the values of any applicable keys. "-t2" causes acuconnect to produce a message whenever a connection request is made or a disconnect is performed. It also outputs a message whenever an "acuconnect -kill" command is processed. "-t3" causes both level 1 and level 2 messages to be output. Values other than 1, 2, or 3, including null, are treated as 1.
-version	Causes the version number of acuconnect to be output. "-version" must be the only argument on the command line. You should run this command from the directory where you started AcuConnect.