extensions-tool: Add a man page
https://gitlab.gnome.org/GNOME/gnome-shell/issues/1234
This commit is contained in:
parent
0de5209cf1
commit
1b40abe37a
@ -137,6 +137,10 @@ bash_completion = dependency('bash-completion', required: false)
|
||||
if get_option('man')
|
||||
xsltproc = find_program('xsltproc')
|
||||
|
||||
if get_option('extensions_tool')
|
||||
a2x = find_program('a2x')
|
||||
endif
|
||||
|
||||
subdir('man')
|
||||
endif
|
||||
|
||||
|
100
src/extensions-tool/man/gnome-extensions.txt
Normal file
100
src/extensions-tool/man/gnome-extensions.txt
Normal file
@ -0,0 +1,100 @@
|
||||
GNOME-EXTENSIONS(1)
|
||||
===================
|
||||
:man manual: User Commands
|
||||
:man source: GNOME-EXTENSIONS-TOOL
|
||||
:doctype: manpage
|
||||
:date: August 2018
|
||||
|
||||
NAME
|
||||
----
|
||||
gnome-extensions - Command line tool for managing GNOME extensions
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
*gnome-extensions* help ['COMMAND']
|
||||
|
||||
*gnome-extensions* version
|
||||
|
||||
*gnome-extensions* enable 'UUID'
|
||||
|
||||
*gnome-extensions* disable 'UUID'
|
||||
|
||||
*gnome-extensions* list ['OPTION'...]
|
||||
|
||||
*gnome-extensions* create ['OPTION'...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
*gnome-extensions* is a utility that makes some common GNOME extensions
|
||||
operations available on the command line.
|
||||
|
||||
COMMANDS
|
||||
--------
|
||||
*help* ['COMMAND']::
|
||||
Displays a short synopsis of the available commands or provides
|
||||
detailed help on a specific command.
|
||||
|
||||
*version*::
|
||||
Prints the program version.
|
||||
|
||||
*enable* 'UUID'::
|
||||
Enables the extension identified by 'UUID'.
|
||||
+
|
||||
The command will not detect any errors from the extension itself, use the
|
||||
*info* command to confirm that the extension state is *ENABLED*.
|
||||
+
|
||||
If the extension is already enabled, the command will do nothing.
|
||||
|
||||
*disable* 'UUID'::
|
||||
Disables the extension identified by 'UUID'.
|
||||
+
|
||||
If the extension is not enabled, the command will do nothing.
|
||||
|
||||
*list* ['OPTION'...]::
|
||||
Displays a list of installed extensions.
|
||||
+
|
||||
.Options
|
||||
*--user*;;
|
||||
Include extensions installed in the user's *$HOME*
|
||||
|
||||
*--system*;;
|
||||
Include extensions installed in the system
|
||||
|
||||
*--enabled*;;
|
||||
Include enabled extensions
|
||||
|
||||
*--disabled*;;
|
||||
Include disabled extensions
|
||||
|
||||
*-d*;;
|
||||
*--details*;;
|
||||
Show some extra information for each extension
|
||||
|
||||
*create* ['OPTION'...]::
|
||||
Creates a new extension from a template.
|
||||
+
|
||||
.Options
|
||||
*--name*='NAME':::
|
||||
Set the user-visible name in the extension's metadata
|
||||
to 'NAME'
|
||||
|
||||
*--description*='DESC':::
|
||||
Set the description in the extension's metadata to 'DESC'
|
||||
|
||||
*--uuid*='UUID':::
|
||||
Set the unique extension ID in the metadata to 'UUID'
|
||||
|
||||
*-i*:::
|
||||
*--interactive*:::
|
||||
Prompt for any extension metadata that hasn't been provided
|
||||
on the command line
|
||||
|
||||
|
||||
EXIT STATUS
|
||||
-----------
|
||||
On success 0 is returned, a non-zero failure code otherwise.
|
||||
|
||||
BUGS
|
||||
----
|
||||
The tool is part of the gnome-shell project, and bugs should be reported
|
||||
in its issue tracker at https://gitlab.gnome.org/GNOME/gnome-shell/issues.
|
7
src/extensions-tool/man/meson.build
Normal file
7
src/extensions-tool/man/meson.build
Normal file
@ -0,0 +1,7 @@
|
||||
custom_target('gnome-extensions.1',
|
||||
input: ['gnome-extensions.txt', 'stylesheet.xsl'],
|
||||
output: 'gnome-extensions.1',
|
||||
command: [a2x, '-D', '@OUTDIR@', '--xsl-file', '@INPUT1@', '-f', 'manpage', '@INPUT0@'],
|
||||
install_dir: mandir + '/man1',
|
||||
install: true
|
||||
)
|
27
src/extensions-tool/man/stylesheet.xsl
Normal file
27
src/extensions-tool/man/stylesheet.xsl
Normal file
@ -0,0 +1,27 @@
|
||||
<?xml version='1.0'?>
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version='1.0'>
|
||||
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/>
|
||||
|
||||
<xsl:template match="variablelist/title">
|
||||
<xsl:text>.PP </xsl:text>
|
||||
<xsl:call-template name="bold">
|
||||
<xsl:with-param name="node" select="."/>
|
||||
<xsl:with-param name="context" select=".."/>
|
||||
</xsl:call-template>
|
||||
<xsl:text> </xsl:text>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="varlistentry[preceding-sibling::title]">
|
||||
<xsl:if test="not(preceding-sibling::varlistentry)">
|
||||
<xsl:text>.RS 4 </xsl:text>
|
||||
<!-- comment out the leading .PP added by the original template -->
|
||||
<xsl:text>.\"</xsl:text>
|
||||
</xsl:if>
|
||||
<xsl:apply-imports/>
|
||||
<xsl:if test="position() = last()">
|
||||
<xsl:text>.RE </xsl:text>
|
||||
</xsl:if>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
@ -32,3 +32,7 @@ if bash_completion.found()
|
||||
install_dir: bash_completion.get_pkgconfig_variable('completionsdir')
|
||||
)
|
||||
endif
|
||||
|
||||
if get_option('man')
|
||||
subdir('man')
|
||||
endif
|
||||
|
Loading…
Reference in New Issue
Block a user