From 055703fe26a07abec86aba09f9a51d0b2dc5bac4 Mon Sep 17 00:00:00 2001 From: monsta Date: Sun, 5 Mar 2017 15:17:39 +0300 Subject: man: use manpages as is instead of generating them from sgml same as it's done in all other MATE projects. also drop build-dep on docbook2man, now it's not needed anymore. manpages are moved to data/ directory to avoid conflicts with old generated manpages in man/ directory when doing git pull (in case generated files are present). therefore man/ directory is removed completely. --- Makefile.am | 1 - configure.ac | 10 --- data/Makefile.am | 9 ++- data/mate-power-backlight-helper.1 | 29 +++++++ data/mate-power-manager.1 | 29 +++++++ data/mate-power-preferences.1 | 21 +++++ data/mate-power-statistics.1 | 22 ++++++ man/Makefile.am | 32 -------- man/mate-power-backlight-helper.sgml | 145 ---------------------------------- man/mate-power-manager.sgml | 146 ----------------------------------- man/mate-power-preferences.sgml | 136 -------------------------------- man/mate-power-statistics.sgml | 136 -------------------------------- 12 files changed, 109 insertions(+), 607 deletions(-) create mode 100644 data/mate-power-backlight-helper.1 create mode 100644 data/mate-power-manager.1 create mode 100644 data/mate-power-preferences.1 create mode 100644 data/mate-power-statistics.1 delete mode 100644 man/Makefile.am delete mode 100644 man/mate-power-backlight-helper.sgml delete mode 100644 man/mate-power-manager.sgml delete mode 100644 man/mate-power-preferences.sgml delete mode 100644 man/mate-power-statistics.sgml diff --git a/Makefile.am b/Makefile.am index 5fd9083..24b8441 100644 --- a/Makefile.am +++ b/Makefile.am @@ -4,7 +4,6 @@ ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} SUBDIRS = \ src \ po \ - man \ data \ help \ policy diff --git a/configure.ac b/configure.ac index 33d81e6..7f18529 100644 --- a/configure.ac +++ b/configure.ac @@ -221,15 +221,6 @@ AC_CHECK_LIB(kstat, kstat_open, ]) AC_SUBST(GPM_EXTRA_LIBS) -dnl --------------------------------------------------------------------------- -dnl - Is docbook2man available? -dnl --------------------------------------------------------------------------- -AC_PATH_PROG(DOCBOOK2MAN, docbook2man, no) -if test "$DOCBOOK2MAN" = "no" ; then - AC_MSG_WARN([docbook2man not found, will not be able to build man documentation]) -fi -AM_CONDITIONAL(HAVE_DOCBOOK2MAN, [test "$DOCBOOK2MAN" != "no"]) - dnl --------------------------------------------------------------------------- dnl - Makefiles, etc. dnl --------------------------------------------------------------------------- @@ -239,7 +230,6 @@ src/Makefile applets/Makefile applets/brightness/Makefile applets/inhibit/Makefile -man/Makefile help/Makefile po/Makefile.in policy/Makefile diff --git a/data/Makefile.am b/data/Makefile.am index 9d8a746..5b7383f 100644 --- a/data/Makefile.am +++ b/data/Makefile.am @@ -30,12 +30,19 @@ pkgdata_DATA = \ gpm-prefs.ui \ acme.ui +man_MANS = \ + mate-power-manager.1 \ + mate-power-backlight-helper.1 \ + mate-power-statistics.1 \ + mate-power-preferences.1 + EXTRA_DIST = \ $(service_in_files) \ $(autostart_in_files) \ $(desktop_in_files) \ $(gsettings_schemas_in_files) \ - $(pkgdata_DATA) + $(pkgdata_DATA) \ + $(man_MANS) clean-local : rm -f *~ diff --git a/data/mate-power-backlight-helper.1 b/data/mate-power-backlight-helper.1 new file mode 100644 index 0000000..9ae0cf6 --- /dev/null +++ b/data/mate-power-backlight-helper.1 @@ -0,0 +1,29 @@ +.TH "MATE-POWER-BACKLIGHT-HELPER" "1" "21 April, 2014" "" "" +.SH NAME +mate-power-backlight-helper \- helper application for MATE's power management backlight control +.SH SYNOPSIS +\fBmate-power-backlight-helper\fR [ \fB\-\-help\fR ] [ \fB\-\-set-brightness\fR ] [ \fB\-\-get-brightness\fR ] [ \fB\-\-get-max-brightness\fR ] +.SH "DESCRIPTION" +\fBmate-power-backlight-helper\fR is a helper utility for controlling the backlight of TFT displays via the MATE power manager userspace daemon. +.PP +The \fBmate-power-backlight-helper\fR requires to be run with root privileges. +.SH "OPTIONS" +.TP +\fB\-\-help\fR +Show summary of options. +.TP +\fB\-\-set-brightness BRIGHTNESS_LEVEL\fR +Set the given brightness. +.TP +\fB\-\-get-brightness\fR +Get the current brightness. +.TP +\fB\-\-get-max-brightness\fR +Get the number of brightness levels supported. +.SH "SEE ALSO" +.PP +mate-power-manager (1). +.SH "AUTHOR" +.PP +This manual page has been written by Mike Gabriel for +the Debian system (but may be used by others). diff --git a/data/mate-power-manager.1 b/data/mate-power-manager.1 new file mode 100644 index 0000000..43c41e3 --- /dev/null +++ b/data/mate-power-manager.1 @@ -0,0 +1,29 @@ +.TH "MATE-POWER-MANAGER" "1" "29 March,2006" "" "" +.SH NAME +mate-power-manager \- MATE power manager userspace daemon +.SH SYNOPSIS +\fBmate-power-manager\fR [ \fB\-\-verbose\fR ] [ \fB\-\-debug\fR ] [ \fB\-\-help\fR ] +.SH "DESCRIPTION" +\fBmate-power-manager\fR is the backend program of the MATE power management infrastructure providing a complete and integrated solution to power management under the MATE desktop environment. +.PP +It supports features such as suspending, hibernating, screen blanking, cpu frequency switching and more in one small neat package. +.SH "OPTIONS" +.TP +\fB\-\-help\fR +Show summary of options. +.TP +\fB\-\-verbose\fR +Show extra debugging. +.TP +\fB\-\-no-daemon\fR +Do not detach \fBmate-power-manager\fR into the background so that error messages will be displayed on console. +.TP +\fB\-\-debug\fR +Only show specific debugging options. Useful for developers only. +.SH "SEE ALSO" +.PP +mate-power-preferences (1). +.SH "AUTHOR" +.PP +This manual page was written by Oliver Grawert for +the Debian system and updated by Ow Mun Heng diff --git a/data/mate-power-preferences.1 b/data/mate-power-preferences.1 new file mode 100644 index 0000000..f160c64 --- /dev/null +++ b/data/mate-power-preferences.1 @@ -0,0 +1,21 @@ +.TH "MATE-POWER-PREFERENCES" "1" "11 July, 2005" "" "" +.SH NAME +mate-power-preferences \- MATE power preferences GUI +.SH SYNOPSIS +\fBmate-power-preferences\fR [ \fB\-\-verbose\fR ] [ \fB\-\-help\fR ] +.SH "DESCRIPTION" +\fBmate-power-preferences\fR is the gui program for the mate power management infrastructure +.SH "OPTIONS" +.TP +\fB\-\-help\fR +Show summary of options. +.TP +\fB\-\-verbose\fR +Show extra debugging. +.SH "SEE ALSO" +.PP +mate-power-manager (1). +.SH "AUTHOR" +.PP +This manual page was written by Oliver Grawert for +the Debian system. diff --git a/data/mate-power-statistics.1 b/data/mate-power-statistics.1 new file mode 100644 index 0000000..38a2785 --- /dev/null +++ b/data/mate-power-statistics.1 @@ -0,0 +1,22 @@ +.TH "MATE-POWER-STATISTICS" "1" "11 December, 2007" "" "" +.SH NAME +mate-power-statistics \- MATE power statistics GUI +.SH SYNOPSIS +\fBmate-power-statistics\fR [ \fB\-\-verbose\fR ] [ \fB\-\-help\fR ] +.SH "DESCRIPTION" +\fBmate-power-statistics\fR is the gui program for the mate power management infrastructure. +.PP +It allows users to visualize the power consumption of laptop hardware. +.SH "OPTIONS" +.TP +\fB\-\-help\fR +Show summary of options. +.TP +\fB\-\-verbose\fR +Show extra debugging. +.SH "SEE ALSO" +.PP +mate-power-manager (1), mate-power-preferences (1). +.SH "AUTHOR" +.PP +This manual page was written by Simon Zheng . diff --git a/man/Makefile.am b/man/Makefile.am deleted file mode 100644 index efa0d2e..0000000 --- a/man/Makefile.am +++ /dev/null @@ -1,32 +0,0 @@ -EXTRA_DIST = \ - mate-power-manager.sgml \ - mate-power-backlight-helper.sgml \ - mate-power-statistics.sgml \ - mate-power-preferences.sgml - -if HAVE_DOCBOOK2MAN -man_MANS = \ - mate-power-manager.1 \ - mate-power-backlight-helper.1 \ - mate-power-statistics.1 \ - mate-power-preferences.1 -endif - -if HAVE_DOCBOOK2MAN -mate-power-manager.1: mate-power-manager.sgml - docbook2man $? - -mate-power-backlight-helper.1: mate-power-backlight-helper.sgml - docbook2man $? - -mate-power-preferences.1: mate-power-preferences.sgml - docbook2man $? - -mate-power-statistics.1: mate-power-statistics.sgml - docbook2man $? -endif - -clean-local : - rm -f *~ - rm -f *.1 - rm -f manpage.* diff --git a/man/mate-power-backlight-helper.sgml b/man/mate-power-backlight-helper.sgml deleted file mode 100644 index d562a63..0000000 --- a/man/mate-power-backlight-helper.sgml +++ /dev/null @@ -1,145 +0,0 @@ - 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/man/mate-power-manager.sgml b/man/mate-power-manager.sgml deleted file mode 100644 index 4ee0586..0000000 --- a/man/mate-power-manager.sgml +++ /dev/null @@ -1,146 +0,0 @@ - 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. - - --> - - - 29 March,2006"> - - - GNU"> - GPL"> -]> - - - -
- richard@hughsie.com; -
- - Richard - Hughes - - - 2005 - Richard Hughes - - &date; - - - mate-power-manager - 1 - - - &package; - - mate power manager userspace daemon - - - - &package; - - - - - - - DESCRIPTION - - This manual page documents briefly the - &package; command. - - &package; is the backend program of the MATE power management infrastructure providing a complete and integrated solution to power management under the MATE desktop environment. - It supports features such as suspending, hibernating, screen blanking, cpu frequency switching and more in one small neat package. - - - - 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. - - - - - - - - Show extra debugging. - - - - - - - - Do not detach &package; into the background so that error messages will be displayed on console. - - - - - - - - Only show specific debugging options. Useful for developers only. - - - - - - - SEE ALSO - - mate-power-preferences (1). - - The programs are documented fully on - http://mate.org/projects/mate-power-manager/ . - - - AUTHOR - - This manual page was written by Oliver Grawert ogra@ubuntu.com for - the Debian system and updated by Ow Mun Heng nikeow@yahoo.com - - - - - - diff --git a/man/mate-power-preferences.sgml b/man/mate-power-preferences.sgml deleted file mode 100644 index adc0231..0000000 --- a/man/mate-power-preferences.sgml +++ /dev/null @@ -1,136 +0,0 @@ - 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. - - --> - - - FIRSTNAME"> - SURNAME"> - - 11 July, 2005"> - - 1"> - ogra@ubuntu.com"> - - mate-power-preferences"> - - - GNU"> - GPL"> -]> - - - -
- richard@hughsie.com; -
- - Richard - Hughes - - - 2005 - Richard Hughes - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - mate power preferences gui - - - - &dhpackage; - - - - - - DESCRIPTION - - This manual page documents briefly the - &dhpackage; command. - - &dhpackage; is the gui program for the mate power management infrastructure - - - - 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. - - - - - - - - Show extra debugging. - - - - - - SEE ALSO - - mate-power-manager (1). - - The programs are documented fully on - http://mate.org/projects/mate-power-manager/ . - - - AUTHOR - - This manual page was written by Oliver Grawert ogra@ubuntu.com for - the Debian system. - - - - - - diff --git a/man/mate-power-statistics.sgml b/man/mate-power-statistics.sgml deleted file mode 100644 index c232346..0000000 --- a/man/mate-power-statistics.sgml +++ /dev/null @@ -1,136 +0,0 @@ - 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. - - --> - - - FIRSTNAME"> - SURNAME"> - - 11 December, 2007"> - - 1"> - simon.zheng@sun.com"> - - mate-power-statistics"> - - - GNU"> - GPL"> -]> - - - -
- richard@hughsie.com; -
- - Richard - Hughes - - - 2005 - Richard Hughes - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - mate power statistics gui - - - - &dhpackage; - - - - - - DESCRIPTION - - This manual page documents briefly the - &dhpackage; command. - - &dhpackage; is the gui program for the mate power management infrastructure. - It allows users to visualize the power consumption of laptop hardware. - - - - 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. - - - - - - - - Show extra debugging. - - - - - - SEE ALSO - - mate-power-manager (1), mate-power-preferences (1). - - The programs are documented fully on - http://mate.org/projects/mate-power-manager/ . - - - AUTHOR - - This manual page was written by Simon Zheng simon.zheng@sun.com. - - - - - - -- cgit v1.2.1