From e3abb6f178cb3a77a09a585d2f756c82ac58149d Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 25 Jul 2012 04:00:55 +0200 Subject: [PATCH] Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601 --- configure.ac | 2 + man/Makefile.am | 12 +++- man/gnome-shell.1 | 94 ------------------------------- man/gnome-shell.xml | 132 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 145 insertions(+), 95 deletions(-) delete mode 100644 man/gnome-shell.1 create mode 100644 man/gnome-shell.xml diff --git a/configure.ac b/configure.ac index eeed23657..ffe917224 100644 --- a/configure.ac +++ b/configure.ac @@ -36,6 +36,8 @@ AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE", PKG_PROG_PKG_CONFIG([0.22]) +AC_PATH_PROG([XSLTPROC], [xsltproc]) + GLIB_GSETTINGS # Get a value to substitute into gnome-shell.in diff --git a/man/Makefile.am b/man/Makefile.am index c4f139f49..510e9c66c 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1 +1,11 @@ -dist_man_MANS = gnome-shell.1 +.xml.1: + $(AM_V_GEN) $(XSLTPROC) -o $@ --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +man_MANS = \ + gnome-shell.1 + +xml_files = $(man_MANS:.1=.xml) + +EXTRA_DIST = $(xml_files) + +DISTCLEANFILES = $(man_MANS) diff --git a/man/gnome-shell.1 b/man/gnome-shell.1 deleted file mode 100644 index 957902da5..000000000 --- a/man/gnome-shell.1 +++ /dev/null @@ -1,94 +0,0 @@ -.\" Copyright (c) 2009, Marcelo Jorge Vieira (metal) -.\" -.\" This is free documentation; you can redistribute it and/or -.\" modify it under the terms of the GNU General Public License as -.\" published by the Free Software Foundation; either version 2 of -.\" the License, or (at your option) any later version. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public -.\" License along with this manual; if not, write to the Free -.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, -.\" Boston, MA 02111-1301 USA. -.TH GNOME-SHELL 1 -.SH NAME -gnome-shell \- Graphical shell for the GNOME desktop - -.SH SYNOPSIS -.B gnome-shell [options] - -.SH DESCRIPTION -GNOME Shell provides core user interface functions for the GNOME 3 -desktop, like switching to windows and launching applications. GNOME -Shell takes advantage of the capabilities of modern graphics hardware -and introduces innovative user interface concepts to provide a -visually attractive and easy to use experience. - -.SH OPTIONS - -.TP -.B \-\-replace -Replace the running window manager -.br - -.TP -.B \-\-sm-disable -Disable connection to the session manager -.br - -.TP -.B \-\-sm-client-id=ID -Specify session management ID -.br - -.TP -.B \-\-sm-save-file=FILE -Initialize session from savefile -.br - -.TP -.B \-\-screen=SCREEN -X screen to use -.br - -.TP -.B \-d, \-\-display=DISPLAY -X display to use -.br - -.TP -.B \-\-sync -Make X calls synchronous -.br - -.TP -.B \-\-version -Print version and exit -.br - -.TP -.B \-\-help -Display help and exit -.br - -.SH BUGS -The bug tracker can be reached by visiting the website -\fIhttps://bugzilla.gnome.org/buglist.cgi?product=gnome-shell\fR - -Before sending a bug report, please verify that you have the latest -version of gnome-shell. Many bugs (major and minor) are fixed at each -release, and if yours is out of date, the problem may already have -been solved. - -.SH ADDITIONAL INFORMATION - -For further information, visit the website \fIhttp://live.gnome.org/GnomeShell\fR diff --git a/man/gnome-shell.xml b/man/gnome-shell.xml new file mode 100644 index 000000000..7e43536cb --- /dev/null +++ b/man/gnome-shell.xml @@ -0,0 +1,132 @@ + + + + + + + gnome-shell + gnome-shell + + + + wrote the original gnome-shell man page + Marcelo Jorge + Vieira + metal@alucinados.com + + + + + + + gnome-shell + 1 + + + + gnome-shell + Graphical shell for the GNOME desktop + + + + + gnome-shell OPTION + + + + + Description + + GNOME shell provides core user + interface functions for the GNOME 3 desktop, like switching + to windows and launching applications. GNOME shell takes + advantage of the capabilities of modern graphics hardware + and introduces innovative user interface concepts to provide + a visually attractive and easy to use experience. + + + + + Options + + + + + + + Replace the running window manager + + + + + + Disable connection to the session manager + + + + + + Specify session management ID + + + + + + Initialize session from FILE + + + + + + X screen to use + + + + , + + X Display to use + + + + + + Make X calls synchronous + + + + + + Print version and exit + + + + + + Display help and exit + + + + + + + + Bugs + + The bug tracker can be reached by visiting the + website https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell. + Before sending a bug report, please verify that you have + the latest version of gnome-shell. Many bugs (major and + minor) are fixed at each release, and if yours is out of + date, the problem may already have been solved. + + + + + Additional Information + + For further information, visit the website + http://live.gnome.org/GnomeShell. + + +