From 324a45a723c377765337900667ea385cbedddb8c Mon Sep 17 00:00:00 2001 From: Mike Gabriel Date: Tue, 22 Apr 2014 00:06:29 +0200 Subject: [PATCH] debian/man: Provide extra man pages (mate-power-manager-bugreport, mate-power-backlight-helper), ignore hyphens-as-minus-signs lintian issues due to Debian bug #208967. --- debian/man/mate-power-backlight-helper.sgml | 145 ++++++++++++++++++ debian/man/mate-power-manager-bugreport.sgml | 103 +++++++++++++ debian/mate-power-manager.lintian-overrides | 14 ++ .../1001_fix-hyphens-on-man-page.patch | 102 ------------ .../2002_compile-extra-man-pages.patch | 37 +++++ debian/patches/series | 2 +- debian/rules | 5 + 7 files changed, 305 insertions(+), 103 deletions(-) create mode 100644 debian/man/mate-power-backlight-helper.sgml create mode 100644 debian/man/mate-power-manager-bugreport.sgml create mode 100644 debian/mate-power-manager.lintian-overrides delete mode 100644 debian/patches/1001_fix-hyphens-on-man-page.patch create mode 100644 debian/patches/2002_compile-extra-man-pages.patch diff --git a/debian/man/mate-power-backlight-helper.sgml b/debian/man/mate-power-backlight-helper.sgml new file mode 100644 index 0000000..d562a63 --- /dev/null +++ b/debian/man/mate-power-backlight-helper.sgml @@ -0,0 +1,145 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + 21 April, 2014"> + + + GNU"> + GPL"> +]> + + + +
+ richard@hughsie.com; +
+ + Richard + Hughes + + + 2005 + Richard Hughes + + &date; +
+ + mate-power-backlight-helper + 1 + + + &package; + + helper application for MATE's power management backlight control + + + + &package; + + + + + + + + DESCRIPTION + + This manual page documents briefly the + &package; command. + + &package; is a helper utility for controlling the backlight of TFT displays via the MATE power manager userspace daemon. + The &package; requires to be run with root privileges. + + + + OPTIONS + + This program follows the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. + + + + + + + + Show summary of options. + + + + + + + + Set the given brightness. + + + + + + + + Get the current brightness. + + + + + + + + Get the number of brightness levels supported. + + + + + + + SEE ALSO + + mate-power-manager (1). + + + + AUTHOR + + This manual page has been written by Mike Gabriel mike.gabriel@das-netzwerkteam.de for + the Debian system (but may be used by others). + + + +
+ + diff --git a/debian/man/mate-power-manager-bugreport.sgml b/debian/man/mate-power-manager-bugreport.sgml new file mode 100644 index 0000000..a458a4e --- /dev/null +++ b/debian/man/mate-power-manager-bugreport.sgml @@ -0,0 +1,103 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + + + The docbook-to-man binary is found in the docbook-to-man package. + Please remember that if you create the nroff version in one of the + debian/rules file targets (such as build), you will need to include + docbook-to-man in your Build-Depends control field. + + --> + + + 21 April, 2014"> + + + GNU"> + GPL"> +]> + + + +
+ richard@hughsie.com; +
+ + Richard + Hughes + + + 2005 + Richard Hughes + + &date; +
+ + mate-power-manager-bugreport + 1 + + + &package; + + collect system information for mate power manager bugreports + + + + &package; + + + + DESCRIPTION + + This manual page documents briefly the + &package; command. + + &package; is a helper script to gather system information for proper mate-power-manager bug reports. + + + + OPTIONS + + This script does not have any known options. + + + + SEE ALSO + + mate-power-manager (1). + + + + AUTHOR + + This manual page has been written by Mike Gabriel mike.gabriel@das-netzwerkteam.de for + the Debian system (but may be used by others). + + + +
+ + diff --git a/debian/mate-power-manager.lintian-overrides b/debian/mate-power-manager.lintian-overrides new file mode 100644 index 0000000..8d712a6 --- /dev/null +++ b/debian/mate-power-manager.lintian-overrides @@ -0,0 +1,14 @@ +# man pages are created with docbook-to-man and the rendering flaw about hyphens and minus signs is +# a documented issue (see https://bugs.debian.org/208967) +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-backlight-helper.1.gz:28 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-backlight-helper.1.gz:31 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-backlight-helper.1.gz:34 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-backlight-helper.1.gz:37 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-manager.1.gz:28 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-manager.1.gz:31 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-manager.1.gz:34 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-manager.1.gz:37 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-preferences.1.gz:26 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-preferences.1.gz:29 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-statistics.1.gz:28 +mate-power-manager: hyphen-used-as-minus-sign usr/share/man/man1/mate-power-statistics.1.gz:31 diff --git a/debian/patches/1001_fix-hyphens-on-man-page.patch b/debian/patches/1001_fix-hyphens-on-man-page.patch deleted file mode 100644 index a5badda..0000000 --- a/debian/patches/1001_fix-hyphens-on-man-page.patch +++ /dev/null @@ -1,102 +0,0 @@ -Description: Fix hyphen-as-minus-sign issues for engrampa.1 man page -Author: Mike Gabriel -Forwarded: https://github.com/mate-desktop/mate-power-manager/issues/99 ---- a/man/mate-power-manager.sgml -+++ b/man/mate-power-manager.sgml -@@ -71,13 +71,13 @@ - OPTIONS - - This program follows the usual &gnu; command line syntax, -- with long options starting with two dashes (`-'). A summary of -+ with long options starting with two dashes (`\-'). A summary of - options is included below. - - - - -- -+ - - - Show summary of options. -@@ -85,7 +85,7 @@ - - - -- -+ - - - Show extra debugging. -@@ -93,7 +93,7 @@ - - - -- -+ - - - Do not detach &package; into the background so that error messages will be displayed on console. -@@ -101,7 +101,7 @@ - - - -- -+ - - - Only show specific debugging options. Useful for developers only. ---- a/man/mate-power-preferences.sgml -+++ b/man/mate-power-preferences.sgml -@@ -78,13 +78,13 @@ - OPTIONS - - This program follows the usual &gnu; command line syntax, -- with long options starting with two dashes (`-'). A summary of -+ with long options starting with two dashes (`\-'). A summary of - options is included below. - - - - -- -+ - - - Show summary of options. -@@ -92,7 +92,7 @@ - - - -- -+ - - - Show extra debugging. ---- a/man/mate-power-statistics.sgml -+++ b/man/mate-power-statistics.sgml -@@ -79,13 +79,13 @@ - OPTIONS - - This program follows the usual &gnu; command line syntax, -- with long options starting with two dashes (`-'). A summary of -+ with long options starting with two dashes (`\-'). A summary of - options is included below. - - - - -- -+ - - - Show summary of options. -@@ -93,7 +93,7 @@ - - - -- -+ - - - Show extra debugging. diff --git a/debian/patches/2002_compile-extra-man-pages.patch b/debian/patches/2002_compile-extra-man-pages.patch new file mode 100644 index 0000000..cc4a7cf --- /dev/null +++ b/debian/patches/2002_compile-extra-man-pages.patch @@ -0,0 +1,37 @@ +Description: Compile extra man pages (mate-power-manager-bugreport) +Author: Mike Gabriel +--- a/man/Makefile.am ++++ b/man/Makefile.am +@@ -1,11 +1,15 @@ +-EXTRA_DIST = \ ++EXTRA_DIST = \ + mate-power-manager.sgml \ +- mate-power-statistics.sgml \ ++ mate-power-manager-bugreport.sgml \ ++ mate-power-backlight-helper.sgml \ ++ mate-power-statistics.sgml \ + mate-power-preferences.sgml + + if HAVE_DOCBOOK2MAN +-man_MANS = \ +- mate-power-manager.1 \ ++man_MANS = \ ++ mate-power-manager.1 \ ++ mate-power-manager-bugreport.1 \ ++ mate-power-backlight-helper.1 \ + mate-power-statistics.1 \ + mate-power-preferences.1 + endif +@@ -14,6 +18,12 @@ + mate-power-manager.1: mate-power-manager.sgml + docbook2man $? + ++mate-power-manager-bugreport.1: mate-power-manager-bugreport.sgml ++ docbook2man $? ++ ++mate-power-backlight-helper.1: mate-power-backlight-helper.sgml ++ docbook2man $? ++ + mate-power-preferences.1: mate-power-preferences.sgml + docbook2man $? + diff --git a/debian/patches/series b/debian/patches/series index 1fc1731..97f96ed 100644 --- a/debian/patches/series +++ b/debian/patches/series @@ -1,3 +1,3 @@ -1001_fix-hyphens-on-man-page.patch 1002_add-keywords-key-to-desktop-files.patch 2001_omit-gfdl-licensed-help-files.patch +2002_compile-extra-man-pages.patch diff --git a/debian/rules b/debian/rules index e507bb3..741786b 100755 --- a/debian/rules +++ b/debian/rules @@ -16,6 +16,7 @@ override_dh_install: dh_install --list-missing override_dh_auto_configure: + cp -v debian/man/*.sgml man/ # ustream is without configure. autogen.sh will create it NOCONFIGURE=1 ./autogen.sh dh_auto_configure $(DHFLAGS) -- \ @@ -28,6 +29,10 @@ override_dh_auto_configure: override_dh_strip: dh_strip --dbg-package=mate-power-manager-dbg +override_dh_clean: + rm -f man/mate-power-manager-bugreport.sgml + dh_clean + get-orig-source: $(PKG)_$(VER)$(DTYPE).orig.tar.xz $(info I: $(PKG)_$(VER)$(DTYPE)) @