hotplug(8) [redhat man page]

HOTPLUG(8)						     Linux Programmer's Manual							HOTPLUG(8)

NAME

       hotplug - Linux hotplugging support scripts

SYNOPSIS

       hotplug [ help | --help | NAME ]

DESCRIPTION

       hotplug	is a program which is used by the kernel to notify user mode software when some significant (usually hardware-related) events take
       place.  An example is when a USB or Cardbus device has just been plugged in.  This is useful for automatically loading and setting up driv-
       ers, packaged either as kernel modules or as user mode programs.

       The  hotplug  program path name is registered in /proc/sys/kernel/hotplug, and normally holds the value /sbin/hotplug.  Except for special-
       ized configurations such as initrd(4) configurations, that identifies a shell script which delegates to specific "policy agents", /etc/hot-
       plug/NAME.agent.   The  name  of  the agent is given by the kernel as the first command-line parameter.	The name corresponds to a specific
       kernel subsystem whose events it processes (e.g. "usb", "pci", "net" etc.).

       Information about an event is usually passed to agents in the form of environment variables.  Most agents accept a "ACTION"  variable  that
       describes  the type of the event.  It can be, for example, "add" or "remove" to signify that some device has just been connected to or dis-
       connected from the system respectively.	In such requests, agents are also given variables describing at the device (and its  location)	so
       that they can choose the appropriate drivers to set up.

       hotplug	agents	aren't	necessarily called only by the kernel though.  While the OS is initializing, the "cold-plugging" case, the hotplug
       script in /etc/init.d/hotplug is invoked to make sure that all device connected at boot are properly configured, applying the same rules as
       if they were connected later.

FILES

       /proc/sys/kernel/hotplug   specifies hotplug program path
       /sbin/hotplug		  hotplug program (default path name)
       /etc/hotplug/*		  hotplug files
       /etc/hotplug/NAME.agent	  hotplug subsystem-specific agents
       /etc/hotplug/NAME*	  subsystem-specific files, for agents
       /etc/hotplug/NAME/*	  driver setup scripts, invoked by agents

SEE ALSO

       initrd(4)

       The http://linux-hotplug.sourceforge.net/ web site.

AUTHORS

       hotplug is developed by Linux Hotplugging Project http://linux-hotplug.sourceforge.net/

       This manual page was originally written by Fumitoshi UKAI <ukai@debian.or.jp>, for the Debian GNU/Linux system (but may be used by others),
       based on original Japanese version of manpage.

								   February 2001							HOTPLUG(8)

BCMXCP_USB(8)							    NUT Manual							     BCMXCP_USB(8)

NAME

       bcmxcp_usb - Experimental driver for UPSes supporting the BCM/XCP protocol over USB

NOTE

       This man page only documents the hardware-specific features of the bcmxcp_usb driver. For information about the core driver, see
       nutupsdrv(8). This driver is a variant of the serial driver bcmxcp and uses the same core code.

SUPPORTED HARDWARE

       This driver should recognize all BCM/XCP-compatible UPSes that are connected via USB. It has been developed and tested on Powerware PW3501
       hardware. It also has been tested on PW5110 hardware.

EXTRA ARGUMENTS

       This driver supports the following optional settings in the ups.conf(5).

       shutdown_delay=delay
	   The number of seconds that the UPS should wait between receiving the shutdown command and actually shutting off.

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

       shutdown_delay =120

INSTANT COMMANDS

       This driver supports the following Instant Commands:

       shutdown.return
	   Turn off the load and return when power is back.

       shutdown.stayoff
	   Turn off the load and remain off.

       test.battery.start
	   Start a battery test.

TODO LIST

       Report UPS alarm status
	   BCM/XCP supports reporting a wide range of UPS alarm conditions.

       Report UPS statistics informations
	   BCM/XCP supports reporting of UPS statistics data.

EXPERIMENTAL DRIVER

       This driver has been tagged experimental, even if it has been reported to be stable. Thus it is not suitable for production systems and it
       is not built by default. This is mainly due to the fact that it is a new driver.

INSTALLATION

       This driver is not built by default. You can build it by using "configure --with-usb=yes". Note that it will also install other USB
       drivers.

       You also need to install manually the hotplug files (libhidups and libhid.usermap), generally in etc/hotplug/usb/, to address the
       permission settings problem. Lastly note that the libhidups file must have execution flag set (ie using chmod +x ...).

IMPLEMENTATION

       bcmxcp_usb only supports 1 UPS at this time. You can put the "auto" value for port in ups.conf, i.e.:

	   [pw3105]
		   driver = bcmxcp_usb
		   port = auto

KNOWN ISSUES AND BUGS

    Got EPERM: Operation not permitted upon driver startup""
       You have forgotten to install the hotplug files, as explained in the INSTALLATION section above. Don't forget to restart hotplug so that it
       applies these changes.

AUTHOR

       Tore Orpetveit <tore@orpetveit.net>, Wolfgang Ocker <weo@weo1.de>

SEE ALSO

   The core driver:
       nutupsdrv(8)

   Internet resources:
       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

Network UPS Tools						    05/21/2012							     BCMXCP_USB(8)