sendprofile

Synopsis

sendprofile [-h] [-c <CONFIG>] [-i <INSTANCE>] [-t <TIME>] [-v] url

Description

sendprofile sends the monthly profile-status notification out to all the people with profiles in a GroupServer instance. Normally it is called by cron(8).

Positional Arguments

url

The URL for the GroupServer site.

Optional Arguments

-h, --help

Show a help message and exit

-c <CONFIG>, --config <CONFIG>

The name of the GroupServer Configuration file (default INSTANCE_HOME/etc/gsconfig.ini) that contains the token that will be used to authenticate the script when it tries to add the email to the site.

-i <INSTANCE>, --instance <INSTANCE>

The identifier of the GroupServer instance configuration to use (default default).

-v, --verbose

Turn on verbose output (default is silent).

-t <TIME>, --throttle <TIME>

The time (in seconds) to pause when the notifications is successfully sent (default 0). For large sites sending the notification can be computationally expensive, and adding a throttle allows other requests to be processed by the server.

Returns

sendprofile returns

  • 0 on success,
  • 130 if the user terminated the program (Control-c), or
  • A value following the convention specified in /usr/include/sysexits.h.