billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 
runhook
Prev  BillMax Executables  Next

Name

runhook — Setuid wrapper for BillMax BillMax Hooks. Internal BillMax command.

Synopsis

/usr/local/billmax/bin/runhook [ OPTIONS ] [file]

DESCRIPTION

Setuid wrapper for BillMax BillMax Hooks. This program is used by BillMax to execute the BillMax Hooks. A BillMax Hook is executed under the privileges of username and groupname.

username is determined in the following order:

  1. The user specified with the -u.

  2. The environment variable RUNHOOK_USER. Note that this is specified in /usr/local/billmax/local/billmax.conf.

  3. "nobody".

groupname is determined in the following order:

  1. The group specified with the -g.

  2. The environment variable RUNHOOK_GROUP. Note that this is specified in /usr/local/billmax/local/billmax.conf.

  3. "nobody".

OPTIONS

-a

Use an alternative directory for locating the BillMax Hooks to execute. The default directory is /usr/local/billmax/local. If this option is specified, the alternate directory is /usr/local/billmax/secure/username. See previous discussion on how username is determined.

-g groupname

The BillMax Hook is executed under groupname privileges.

-n

By default, like executions of a BillMax Hook are serialized, i.e. two simultaneous executions of the same BillMax Hook is prohibited. Specifying this options allows two or more simultaneous executions of a the same BillMax Hook.

-u username

The BillMax Hook is executed as if UserName is executing the BillMax Hook.

-h

Show help for this program.

RETURN VALUE

System value EX_OK for success.

NOTES

This may create a lock file called /tmp/hookbase_hook_lock where hook is the basename of the BillMax Hook (i.e. "service", "user", etc.)

SEE ALSO

NONE

Prev  Up  Next
report2csv.pl  Home  search
Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com