contents.gifindex.gifprev1.gifnext1.gif

7.1 acuserve Command Formats

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

   Usage:
      acuserve
      acuserve  -access
      acuserve  -info [server] [-n num]
      acuserve  -install [server] [-n num]*
      acuserve  -kill [server] [-f] [-n num]
      acuserve  -remove [server] [-n num]*
      acuserve  -start [-c config_file] [-e error_file]
                   [-l] [-t#] [-f] [-n num] [-p port]
      acuserve  -unlock [server] [-a] [-c client
                   [-u user] [-p PID]] [-f FID] [-n num]
      acuserve  -version

* indicates an option that is available only on Windows NT (Intel) servers.

acuserve -access starts the server access file manager utility. The access file manager is used to create and maintain the database of authorized AcuServer clients and users. To use "-access" you must be logged onto a UNIX server as root or superuser or onto a Windows NT (Intel) server from an account that belongs to the Administrators group. For a description of this tool, see section 8.3.

acuserve -info returns a report of AcuServer system status for the current host (unless another machine is specified). Optional arguments to "-info" include:

-info server specifies the name of the server machine whose status is to be reported.

-info -n identifies a particular instance of the acuserve program by server-number. The "-n" must be followed a space and then an integer. If no server-number is specified, then status for server-number "1" is reported.

For a description of the report format, see section 7.3.

acuserve -install is for Windows NT (Intel) servers only. It installs AcuServer as a Windows NT service.

Optional arguments to "-install" include:

-install server specifies the name of the server machine. If no server is specified, the server is assumed to be the local host.

-install -n assigns a server-number to this instance of the acuserve program. The "-n" must be followed a space and then an integer. This number is used instead of the SERVER-NUMBER variable in the server configuration file.

If you plan to have multiple instances of the acuserve service running at the same time, each instance must have a unique name. The name of an installed service will be AcuserveX, where X is the number you specified with this option. If you specify "-n 1" or do not use the "-n" option, then the name of the service will be Acuserve.

Client applications can, in turn, be assigned to a particular instance of the acuserve service via the SERVER-NUMBER variable in the runtime configuration file. This can help to balance the client load and improve performance.

acuserve -kill causes the acuserve process to be halted (killed). If no server is specified, the acuserve process is halted on the current host; otherwise the process is halted on the named host.

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

acuserve attempts to close all open files before shutting down.

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

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

Respond by entering "Y" or "N".

Optional arguments to "-kill" include:

-kill -f causes the acuserve process to terminate immediately, without prompting for confirmation. "-f" should be used when "acuserve -kill" is included in a program or script.

-kill -n identifies a particular instance of the acuserve program by server-number. The "-n" must be followed a space and then an integer. If no server-number is specified, then server-number " 1" is terminated.

The acuserve 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 acuserve from performing an orderly shutdown and should never be used when clients are actively using AcuServer.

Under Windows NT (Intel), you can use the command "sc stop AcuServer", or you can use the AcuServer icon titled "Stop AcuServer Service".

acuserve -remove is for Windows NT (Intel) servers only. It shuts down AcuServer (if it is not already shut down) and removes the Windows NT service for AcuServer.

Optional arguments to "-remove" include:

-remove server specifies the name of the server machine. If no server is specified, the server is assumed to be the local host.

-remove -n identifies a particular instance of the acuserve program by server-number. The "-n" must be followed a space and then an integer. If no server-number is specified, then server-number "1" (which has the service name "Acuserve") is removed. See the "-install" option above for more information about server-numbers.

acuserve -start causes acuserve to be started. On Windows NT (Intel) servers, this option also installs AcuServer as a Windows NT 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 (Intel) server, you must use "-start" from an account that belongs to the Administrators group.

acuserve is started in background unless the "-f" option is specified. If acuserve is already running, AcuServer will output the message:

acuserve is already running on hostname

A new acuserve process will not be started. If you want to start AcuServer with new options, you must stop and restart acuserve.

Important note for Windows NT

On Windows NT systems, it is best to specify "acuserve -start" with no options. This causes it to use the server configuration variable SERVER-START-<server#> to determine its start-up options. The service for AcuServer uses this variable when the system boots. If you specify options with "acuserve -start" then these options will be in effect only until the acuserve service is started again. (Command line options are not used when the system is rebooted.) See section 6.1.2 for more details about the SERVER-START-<server#> variable.

Optional arguments to "-start" include:

-start -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, acuserve looks for the configuration file in its default location: "/etc/a_srvcfg" for UNIX or " \etc\a_srvcfg" for Windows NT (Intel).

-start -e causes error output from acuserve 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, acuserve will attempt to direct error output to /dev/console. If /dev/console cannot be opened, acuserve will attempt to append to a file named acuserve.err in the current directory. If that file doesn't exist, or the file append fails, acuserve will print the message "acuserve: can't open error output file" to standard output, and acuserve will terminate.

-start -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 this option is combined with the "-e" option, the listing is captured in the error output file.

-start -t# Turns on file tracing and transaction logging. When combined with the "-e" option, file trace and transaction messages are placed in the named error file.

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

"-t2" causes acuserve to produce a message whenever a connection request is made or a disconnect is performed. It also outputs a message whenever an "acuserve -status", "acuserve -kill", or "acuserve -unlock" 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.

"-t5" generates the same output as "-t" and "-t1" but also causes the file trace buffer to be flushed to disk after every WRITE operation (file trace flushing can also be controlled with the FILE-TRACE-FLUSH server configuration variable; see section 6.1.2).

"-t6" generates the same output as "-t2" but also causes the file trace buffer to be flushed to disk after every WRITE operation.

"-t7" generates the same output as "-t3" but also causes the file trace buffer to be flushed to disk after every WRITE operation.

-start -f By default, acuserve runs in background. Use the "-f" option to run acuserve in foreground. When run in foreground, the acuserve process traps normal keyboard signals, such as Control-C.

If combined with the "-t" option, the "-f" option causes acuserve 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.

-start -n Assigns a server-number to this instance of the acuserve program. The "-n" must be followed a space and then an integer. It overrides the SERVER-NUMBER set in the server configuration file.

The "-n" option associates a server-number with one instance of the acuserve daemon. Client applications can, in turn, be assigned to a particular instance of the acuserve daemon via the SERVER-NUMBER variable in the runtime configuration file.

-start -p Assigns a port number to this instance of the acuserve program. The "-p" must be followed by a space and then an integer port number. This is especially helpful when the server host machine has a security firewall, because firewalls generally allow access only to specific ports. With this variable, the site can ensure that firewall restrictions are satisfied.

The acuserve daemon can work with privileged port numbers (from 0 to 1023), and with non-privileged port numbers (1024 and higher).

acuserve -unlock unlocks and closes files held open by acuserve. To use "-unlock" you must be logged onto a UNIX server as root or superuser or onto a Windows NT (Intel) server from an account that belongs to the Administrators group.

Before using "-unlock", use "acuserve -info" to get a current listing of all open files.

WARNING: If "acuserve -unlock [server] -a" is entered, all open files will immediately be closed. No confirmation prompt is output. See section 7.4.

When "acuserve -unlock [server]" is entered without any other options, the unlock facility enters into an interactive mode. In interactive mode you will be prompted for the FID, client name, user name and PID. Enter only the information needed to effect removal. Leave the other fields blank. acuserve will redisplay your selection information and prompt for confirmation before closing any files. For more details and examples, see section 7.4.

Optional arguments to "-unlock" include:

-unlock [server] specifies the name of the AcuServer server. If no server is specified, the server is assumed to be the local host.

-unlock -a causes all open files on the server to be immediately closed. "-a" does not ask the user for confirmation before closing all files.

-unlock -f FID causes the file associated with the specified FID to be unlocked and closed. "-f" must be followed by a space and the FID of an open file.

-unlock -c client When "-c" is used with no other options, acuserve unlocks and closes all files held open for the named client on the current host. "-c" must be followed by a space and the name of an AcuServer client. Use "-c" in combination with the server option to specify a server other than the current host. "-c" can be qualified by the "-u" or "-p" options.

-unlock -u user is used as a qualifier to the "-c" option. "-u" must be followed by a space and the name of an AcuServer user. The "-c client -u user" combination causes acuserve to close all files associated with the named user on the named client.

-unlock -p PID is used as a qualifier to the "-c" option. "-p" must be followed by a space and the PID of a client process. The "-c client -p PID" combination causes acuserve to close all files associated with the specified PID on the named client.

-unlock -n num identifies a particular instance of the acuserve program by server-number. The "-n" must be followed a space and then an integer. This option causes only those files associated with the specified instance of the acuserve program to be unlocked and closed. If no server-number is specified, then files for server-number "1"> are unlocked and closed.

acuserve -version causes the version number of acuserve to be output. "-version" must be the only argument on the command line.