From 9298993fbe5237d16847f40d5f48aeacaf796af7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 1 May 2015 19:49:49 +0200 Subject: [PATCH] added man page --- debian/changelog | 4 +-- debian/control | 83 +++++++++++++++++++++---------------------- debian/copyright | 1 + debian/guhd.manpage.1 | 36 +++++++++++++++++++ debian/manpages | 1 + 5 files changed, 80 insertions(+), 45 deletions(-) create mode 100644 debian/guhd.manpage.1 create mode 100644 debian/manpages diff --git a/debian/changelog b/debian/changelog index 256ee2a2..b5fc332d 100644 --- a/debian/changelog +++ b/debian/changelog @@ -8,13 +8,13 @@ guh (0.2.0) UNRELEASED; urgency=medium * split plugins into dynamic libs and packages - -- Michael Zanetti Sat, 11 Oct 2014 05:09:41 +0200 + -- Michael Zanetti Sat, 11 Oct 2014 05:09:41 +0200 guh (0.1.8) utopic; urgency=medium * allow calling AddRule with a single eventDescriptor but also with a list - -- Michael Zanetti Sun, 15 Jun 2014 00:33:36 +0200 + -- Michael Zanetti Sun, 15 Jun 2014 00:33:36 +0200 guh (0.1.7) utopic; urgency=medium diff --git a/debian/control b/debian/control index 0bf31d14..7032e457 100644 --- a/debian/control +++ b/debian/control @@ -1,7 +1,7 @@ Source: guh Section: utils Priority: optional -Maintainer: Michael Zanetti +Maintainer: Simon Stuerz Build-Depends: debhelper (>= 9.0.0), dpkg-dev (>= 1.16.1~), hardening-wrapper, @@ -15,11 +15,11 @@ Architecture: any Section: misc Depends: guh (= ${binary:Version}), guh-plugins (= ${binary:Version}), -Description: server for home automation systems - meta package - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Server for home automation systems - meta package + guh 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. This meta package installs the guh daemon and the main plugins. Package: guhd @@ -30,11 +30,11 @@ Depends: libqt5network5, libguh1 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends} -Description: server for home automation systems - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Server daemon for home automation systems + guh 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. Package: guh-dbg Priority: extra @@ -42,43 +42,43 @@ Architecture: any Section: debug Depends: guh (= ${binary:Version}), ${misc:Depends} Description: server for home automation systems - debug symbols - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. + guh 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. Package: guh-doc Section: doc Architecture: all Depends: ${misc:Depends} Recommends: guh (= ${binary:Version}) -Description: documentation for the guh package (on-site) - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Documentation for the guh package (on-site) - documentation + guh 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. Package: guh-tests Architecture: any Depends: guh (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends} -Description: tests for the guh package - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Tests for the guh package + guh 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. Package: libguh1 Section: libs Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} -Description: server for home automation systems - core library - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Server for home automation systems - core library + guh 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. Package: libguh1-dev Section: libdevel @@ -86,11 +86,11 @@ Architecture: any Depends: libguh1 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends} -Description: server for home automation systems - development files - 'Gear Up your Home!' - Home automation server. - guh is a home automation system aiming for easy integration of various - existing home automation and controlling devices into a fully automated - system. +Description: Server for home automation systems - development files + guh 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. Package: guh-plugins Section: libs @@ -99,11 +99,8 @@ Depends: libguh1 (= ${binary:Version}), guhd (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends} -Description: server for home automation systems - plugins - guh stands for 'Gear Up your Home!' and provide a WebGUI and configuration - for various systems that provide home and house automations. It's - expandable with plugins for a greater functionality. - . - It supports systems like ZigBee, Z-Wave, KNX/EIB, FS20, EnOcean and other. - . - This package contains plugins for guh. +Description: Plugins for guh server home automation systems + guh 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. diff --git a/debian/copyright b/debian/copyright index e1386b5e..60e2e2fe 100644 --- a/debian/copyright +++ b/debian/copyright @@ -14,4 +14,5 @@ License: GPL-2+ Files: debian/* Copyright: (C) 2014 Michael Zanetti + 2014 Simon Stürz License: GPL-2+ diff --git a/debian/guhd.manpage.1 b/debian/guhd.manpage.1 new file mode 100644 index 00000000..4b261b7b --- /dev/null +++ b/debian/guhd.manpage.1 @@ -0,0 +1,36 @@ +.\" 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. +.SH SEE ALSO +Full documentation at: +.SH "REPORTING BUGS" +Git repository on github: +.SH AUTHOR +Written by Simon Stürz and Michael Zanetti +.SH COPYRIGHT +Copyright \(co 2015 guh. +License GPLv2: GNU GPL version 2 . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + diff --git a/debian/manpages b/debian/manpages new file mode 100644 index 00000000..3a6f87f5 --- /dev/null +++ b/debian/manpages @@ -0,0 +1 @@ +debian/guhd.manpage.1