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.
This commit is contained in:
Mike Gabriel
parent
6ed741a04a
commit
324a45a723
145
debian/man/mate-power-backlight-helper.sgml
vendored
Normal file
145
debian/man/mate-power-backlight-helper.sgml
vendored
Normal file
@ -0,0 +1,145 @@
|
||||
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
||||
|
||||
<!-- Process this file with docbook-to-man to generate an nroff manual
|
||||
page: `docbook-to-man manpage.sgml > 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.
|
||||
|
||||
-->
|
||||
|
||||
<!-- Please adjust the date whenever revising the manpage. -->
|
||||
<!ENTITY date "<date>21 April, 2014</date>">
|
||||
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
||||
allowed: see man(7), man(1). -->
|
||||
<!ENTITY package "mate-power-backlight-helper">
|
||||
<!ENTITY gnu "<acronym>GNU</acronym>">
|
||||
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
|
||||
]>
|
||||
|
||||
<refentry>
|
||||
<refentryinfo>
|
||||
<address>
|
||||
<email>richard@hughsie.com</email>;
|
||||
</address>
|
||||
<author>
|
||||
<firstname>Richard</firstname>
|
||||
<surname>Hughes</surname>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2005</year>
|
||||
<holder>Richard Hughes</holder>
|
||||
</copyright>
|
||||
&date;
|
||||
</refentryinfo>
|
||||
<refmeta>
|
||||
<refentrytitle>mate-power-backlight-helper</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>&package;</refname>
|
||||
|
||||
<refpurpose>helper application for MATE's power management backlight control</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>&package;</command>
|
||||
<arg><option>--help</option></arg>
|
||||
<arg><option>--set-brightness</option></arg>
|
||||
<arg><option>--get-brightness</option></arg>
|
||||
<arg><option>--get-max-brightness</option></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
|
||||
<para>This manual page documents briefly the
|
||||
<command>&package;</command> command.</para>
|
||||
|
||||
<para><command>&package;</command> is a helper utility for controlling the backlight of TFT displays via the MATE power manager userspace daemon.</para>
|
||||
<para>The <command>&package;</command> requires to be run with root privileges.</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>OPTIONS</title>
|
||||
|
||||
<para>This program follows the usual &gnu; command line syntax,
|
||||
with long options starting with two dashes (`-'). A summary of
|
||||
options is included below. </para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--help</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show summary of options.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--set-brightness BRIGHTNESS_LEVEL</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Set the given brightness.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--get-brightness</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Get the current brightness.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>--get-max-brightness</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Get the number of brightness levels supported.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
|
||||
<para>mate-power-manager (1).</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>AUTHOR</title>
|
||||
|
||||
<para>This manual page has been written by Mike Gabriel <email>mike.gabriel@das-netzwerkteam.de</email> for
|
||||
the <productname>Debian</productname> system (but may be used by others).
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:2
|
||||
sgml-indent-data:t
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:nil
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
-->
|
||||
103
debian/man/mate-power-manager-bugreport.sgml
vendored
Normal file
103
debian/man/mate-power-manager-bugreport.sgml
vendored
Normal file
@ -0,0 +1,103 @@
|
||||
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
||||
|
||||
<!-- Process this file with docbook-to-man to generate an nroff manual
|
||||
page: `docbook-to-man manpage.sgml > 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.
|
||||
|
||||
-->
|
||||
|
||||
<!-- Please adjust the date whenever revising the manpage. -->
|
||||
<!ENTITY date "<date>21 April, 2014</date>">
|
||||
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
||||
allowed: see man(7), man(1). -->
|
||||
<!ENTITY package "mate-power-manager-bugreport">
|
||||
<!ENTITY gnu "<acronym>GNU</acronym>">
|
||||
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
|
||||
]>
|
||||
|
||||
<refentry>
|
||||
<refentryinfo>
|
||||
<address>
|
||||
<email>richard@hughsie.com</email>;
|
||||
</address>
|
||||
<author>
|
||||
<firstname>Richard</firstname>
|
||||
<surname>Hughes</surname>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2005</year>
|
||||
<holder>Richard Hughes</holder>
|
||||
</copyright>
|
||||
&date;
|
||||
</refentryinfo>
|
||||
<refmeta>
|
||||
<refentrytitle>mate-power-manager-bugreport</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
<refnamediv>
|
||||
<refname>&package;</refname>
|
||||
|
||||
<refpurpose>collect system information for mate power manager bugreports</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>&package;</command>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
|
||||
<para>This manual page documents briefly the
|
||||
<command>&package;</command> command.</para>
|
||||
|
||||
<para><command>&package;</command> is a helper script to gather system information for proper mate-power-manager bug reports.</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>OPTIONS</title>
|
||||
|
||||
<para>This script does not have any known options.</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
|
||||
<para>mate-power-manager (1).</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>AUTHOR</title>
|
||||
|
||||
<para>This manual page has been written by Mike Gabriel <email>mike.gabriel@das-netzwerkteam.de</email> for
|
||||
the <productname>Debian</productname> system (but may be used by others).
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
sgml-omittag:t
|
||||
sgml-shorttag:t
|
||||
sgml-minimize-attributes:nil
|
||||
sgml-always-quote-attributes:t
|
||||
sgml-indent-step:2
|
||||
sgml-indent-data:t
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:nil
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
-->
|
||||
14
debian/mate-power-manager.lintian-overrides
vendored
Normal file
14
debian/mate-power-manager.lintian-overrides
vendored
Normal file
@ -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
|
||||
102
debian/patches/1001_fix-hyphens-on-man-page.patch
vendored
102
debian/patches/1001_fix-hyphens-on-man-page.patch
vendored
@ -1,102 +0,0 @@
|
||||
Description: Fix hyphen-as-minus-sign issues for engrampa.1 man page
|
||||
Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
|
||||
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 @@
|
||||
<title>OPTIONS</title>
|
||||
|
||||
<para>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. </para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--help</option>
|
||||
+ <option>\-\-help</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show summary of options.</para>
|
||||
@@ -85,7 +85,7 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--verbose</option>
|
||||
+ <option>\-\-verbose</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show extra debugging.</para>
|
||||
@@ -93,7 +93,7 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--no-daemon</option>
|
||||
+ <option>\-\-no-daemon</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Do not detach <command>&package;</command> into the background so that error messages will be displayed on console.</para>
|
||||
@@ -101,7 +101,7 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--debug</option>
|
||||
+ <option>\-\-debug</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Only show specific debugging options. Useful for developers only.</para>
|
||||
--- a/man/mate-power-preferences.sgml
|
||||
+++ b/man/mate-power-preferences.sgml
|
||||
@@ -78,13 +78,13 @@
|
||||
<title>OPTIONS</title>
|
||||
|
||||
<para>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. </para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--help</option>
|
||||
+ <option>\-\-help</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show summary of options.</para>
|
||||
@@ -92,7 +92,7 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--verbose</option>
|
||||
+ <option>\-\-verbose</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show extra debugging.</para>
|
||||
--- a/man/mate-power-statistics.sgml
|
||||
+++ b/man/mate-power-statistics.sgml
|
||||
@@ -79,13 +79,13 @@
|
||||
<title>OPTIONS</title>
|
||||
|
||||
<para>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. </para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--help</option>
|
||||
+ <option>\-\-help</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show summary of options.</para>
|
||||
@@ -93,7 +93,7 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
- <option>--verbose</option>
|
||||
+ <option>\-\-verbose</option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Show extra debugging.</para>
|
||||
37
debian/patches/2002_compile-extra-man-pages.patch
vendored
Normal file
37
debian/patches/2002_compile-extra-man-pages.patch
vendored
Normal file
@ -0,0 +1,37 @@
|
||||
Description: Compile extra man pages (mate-power-manager-bugreport)
|
||||
Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
|
||||
--- 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 $?
|
||||
|
||||
2
debian/patches/series
vendored
2
debian/patches/series
vendored
@ -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
|
||||
|
||||
5
debian/rules
vendored
5
debian/rules
vendored
@ -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))
|
||||
@
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user