reloadcustompasswdfile

Output of --help=reloadcustompasswdfile

The following help text is generated by ecflow_client --help=reloadcustompasswdfile

reloadcustompasswdfile
----------------------

Reload the server custom password file. For those user's who don't use login name
This should be used when most users use the machine login name, but a few users specify their own user name,
in this case these user must provide a password.
Although the password file can be reloaded(i.e to add/remove users), its location can't be changed
The password file is located by the ECF_CUSTOM_PASSWD environment variable, both for the client and server
On the server the default file name is <host>.<port>.ecf.custom_passwd
On the client the default file name is ecf.custom_passwd
The format of the file is same for client and server:

4.5.0
# comment
<user> <host> <port> <passwd> # comment

i.e
4.5.0 # the version
fred machine1 3142 xxyyyd
fred machine2 3133 xxyyyd # comment
bill machine2 3133 xxyggyyd

The same user may appear multiple times. i.e with different host/port. This allows the password file
to be used for multiple servers
For the password authentication to work. It must be:
  - Defined for the client and server
  - Creating an empty password file,(i.e with just the version) will mean, no client can reload it.
    Hence at least the server administrator needs to be added to the file
  - The password file permission's must be set for reading by the user only
Usage:
 --reloadcustompasswdfile

The client considers, for both user and child commands, the following environment variables:

  ECF_HOST <string> [mandatory*]
    The main server hostname; default value is 'localhost'
  ECF_PORT <int> [mandatory*]
    The main server port; default value is '3141'
  ECF_SSL <any> [optional*]
    Enable secure communication between client and server.
  ECF_HOSTFILE <string> [optional]
    File that lists alternate hosts to try, if connection to main host fails
  ECF_HOSTFILE_POLICY <string> [optional]
    The policy ('task' or 'all') to define which commands consider using alternate hosts.

The options marked with (*) must be specified in order for the client to communicate
with the server, either by setting the environment variables or by specifying the
command line options.