This repository has been archived on 2026-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
2019-04-01 20:48:17 +02:00

101 lines
3.9 KiB
Groff
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.\" Manpage for guhd.
.\" Contact simon.stuerz@guh.guru to correct errors or typos.
.TH man 1 "May 2015" "1.0" "guhd man page"
.SH NAME
guhd \- Server for home automation systems
.SH SYNOPSIS
.B guhd
[\fIOPTION\fR]
.SH DESCRIPTION
guh (/[guːh]/) is an open source home automation server, which allows to
control a lot of different devices from many different manufacturers.
With the powerful rule engine you are able to connect any device available in
the system and create individual scenes and behaviors for your home.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Displays this help.
.TP
\fB\-v\fR, \fB\-\-version\fR
Displays version information.
.TP
\fB\-n\fR, \fB\-\-no\-daemon\fR
Run guhd in the foreground, not as daemon.
.TP
\fB\-d\fR, \fB\-\-debug\fR, \fB\<[No\]DebugCategory>\fR
Debug categories to enable. Prefix with \"No\" to disable. Warnings from all
categories will be printed unless explicitly muted with "NoWarnings".
.RS
.TP
\fBMain\ debug\ categories:\fR
.IP \fIApplication\fR\ (default\ enabled)
Print the debug messages from the core application.
.IP \fIConnection\fR\ (default\ enabled)
Print the debug messages from the TCP connections in guh.
.IP \fIDeviceManager\fR\ (default\ enabled)
Print the debug messages from the device manager.
.IP \fIHardware\fR\ (default\ disabled)
Print the debug messages from hardware resources in guh.
.IP \fIJsonRpc\fR\ (default\ disabled)
Print the debug messages from JSON-RPC interface.
.IP \fILogEngine\fR\ (default\ disabled)
Print the debug messages from logging engine.
.IP \fIRuleEngine\fR\ (default\ enabled)
Print the debug messages from the rule engine.
.TP
\fBDebug\ categories\ for\ plugins:\fR
.IP \fICommandLauncher\fR\ (default\ disabled)
Print the debug messages from the command launcher device plugin.
.IP \fIDateTime\fR\ (default\ disabled)
Print the debug messages from the date/time device plugin.
.IP \fIEQ-3\fR\ (default\ disabled)
Print the debug messages from eQ-3 device plugin.
.IP \fILgSmartTv\fR\ (default\ disabled)
Print the debug messages from Lg Smart Tv device plugin.
.IP \fIKodi\fR\ (default\ disabled)
Print the debug messages from kodi device plugin.
.IP \fILircd\fR\ (default\ disabled)
Print the debug messages from lircd device plugin.
.IP \fIMailNotification\fR\ (default\ disabled)
Print the debug messages from the mail notification device plugin.
.IP \fIMock\fR\ (default\ disabled)
Print the debug messages from the mock device plugin.
.IP \fIOpenweahtermap\fR\ (default\ disabled)
Print the debug messages from the open weathermap device plugin.
.IP \fIPhilipsHue\fR\ (default\ disabled)
Print the debug messages from the Philips Hue device plugin.
.IP \fIRF433\fR\ (default\ disabled)
Print the debug messages from the RF 433 MHz plugins. Each plugin which uses the RF 433 MHz
hardware resource is in this debug caterogry.
.IP \fITune\fR\ (default\ disabled)
Print the debug messages from the tune device plugin.
.IP \fIUdpCommander\fR\ (default\ disabled)
Print the debug messages from the UPD commander device plugin.
.IP \fIWakeOnLan\fR\ (default\ disabled)
Print the debug messages from the wake on lan device plugin.
.IP \fIWarnings\fR\ (default\ enabled)
Print warnings of all categories.
.IP \fIWemo\fR\ (default\ disabled)
Print the debug messages from the wemo device plugin.
.IP \fIWifiDetector\fR\ (default\ disabled)
Print the debug messages from the WiFi detector device plugin.
.SH SEE ALSO
Full developer documentation at: <http://dev.guh.guru>
.br
Wiki on github: <https://github.com/guh/guh/wiki>
.SH "REPORTING BUGS"
Issue tracker on github: <https://github.com/guh/guh/issues>
.br
How to report bugs can: <https://github.com/guh/guh/wiki/Reporting-bugs>
.SH AUTHOR
Written by Simon Stürz and Michael Zanetti
.SH COPYRIGHT
Copyright \(co 2013-2015 ARGE guh.
.br
License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
.br
There is NO WARRANTY, to the extent permitted by law.