Add gdctl man page using rst2man

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/4190>

doc/man/gdctl.rst

@@ -0,0 +1,164 @@
+=====
+gdctl
+=====
+
+------------------------
+GNOME Display Controller
+------------------------
+
+:Manual section: 1
+:Manual group: User Commands
+
+SYNOPSIS
+--------
+**gdctl** [-h] COMMAND ...
+
+DESCRIPTION
+-----------
+gdctl provides means to show the active monitor configuration, and set new
+monitor configuration using command line arguments.
+
+It requires a compositor that supports the ``org.gnome.Mutter.DisplayConfig``
+D-Bus API, such as GNOME Shell.
+
+COMMANDS
+--------
+``show``
+
+  Show the current display configuration
+
+``set``
+
+  Set a new display configuration
+
+SHOW OPTIONS
+------------
+``--help``, ``-h``
+
+  Show a help message and exit.
+
+``--modes``, ``-m``
+
+  List available monitor modes.
+
+``--properties``, ``-p``
+
+  List properties.
+
+``--verbose``, ``-v``
+
+  Display all available information (equivalent to ``--modes --properties``).
+
+SET OPTIONS
+-----------
+
+``--help``, ``-h``
+
+  Show a help message and exit.
+
+``--persistent``, ``-P``
+
+  Store applied configuration on persistant storage and restore when applicable.
+
+``--verbose``, ``-v``
+
+  Print configuration to standard out before applying it.
+
+``--verify``, ``-V``
+
+  Only verify, without applying, the configuration.
+
+``--layout-mode LAYOUT-MODE``, ``-l``
+
+  Specify the layout mode the configuration should use. Either ``logical``, or
+  ``physical``.
+
+``--logical-monitor``, ``-L``
+
+  Add and configure a logical monitor. See LOGICAL MONITOR OPTIONS.
+
+LOGICAL MONITOR OPTIONS
+-----------------------
+
+``--monitor CONNECTOR``, ``-M CONNECTOR``
+
+  Add a monitor to the currently configured logical monitor. All monitors
+  within the same logical monitor must have the same monitor resolution.
+
+``--primary``, ``-p``
+
+  Mark currently configured logical monitor as primary.
+
+``--scale SCALE``, ``-s SCALE``
+
+  Scale monitors within the currently configured logical monitor with
+  ``SCALE``. Must be a scale supported by all monitors and their configured
+  modes.
+
+``--transform TRANSFORM``, ``-t TRANSFORM``
+
+  Transform monitors within the currently configured logical monitor using
+  ``TRANSFORM``. Possible transforms are ``normal``, ``90``, ``180``, ``270``,
+  ``flipped``, ``flipped-90``, ``flipped-270`` and ``flipped-180``.
+
+``--x X``, ``-x X``
+
+  Set the X position of the currently configured logical monitor.
+
+``--y``, ``-y Y``             Y position
+
+  Set the Y position of the currently configured logical monitor.
+
+``--right-of CONNECTOR``
+
+  Place the logical monitor to the right of the logical monitor ``CONNECTOR``
+  belongs to.
+
+``--left-of CONNECTOR``   Place left of other monitor
+
+  Place the logical monitor to the left of the logical monitor ``CONNECTOR``
+  belongs to.
+
+``--above CONNECTOR``
+
+  Place the logical monitor above the logical monitor ``CONNECTOR`` belongs to.
+
+``--below CONNECTOR``
+
+  Place the logical monitor below the logical monitor ``CONNECTOR`` belongs to.
+
+MONITOR OPTIONS
+---------------
+
+``--mode``, ``-M``
+
+  Set the mode of the monitor.
+
+EXAMPLES
+--------
+
+Mirror DP-1 and eDP-1, and place DP-2, transformed by 270 degrees, to the right
+of the two mirrored monitors.
+
+::
+
+  gdctl set --logical-monitor
+            --primary
+            --monitor DP-1
+            --monitor eDP-1
+            --logical-monitor
+            --monitor DP-2
+            --right-of DP-1
+
+BUGS
+----
+The bug tracker can be reached by visiting the website
+https://gitlab.gnome.org/GNOME/mutter/-/issues.
+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
+https://gitlab.gnome.org/GNOME/mutter/-/blob/main/README.md.

doc/man/meson.build

@@ -1 +1,12 @@
 install_man('mutter.1')
+
+rst2man = find_program('rst2man')
+
+custom_target('gdctl.1',
+  input: 'gdctl.rst',
+  output: 'gdctl.1',
+  command: [rst2man, '--syntax-highlight=none', '@INPUT@'],
+  capture: true,
+  install_dir: mandir + '/man1',
+  install: true
+)

meson.build

@@ -89,6 +89,7 @@ libdir = prefix / get_option('libdir')
 libexecdir = prefix / get_option('libexecdir')
 includedir = prefix / get_option('includedir')
 sysconfdir = get_option('sysconfdir')
+mandir = prefix / get_option('mandir')
 
 pkgname = '@0@-@1@'.format(meson.project_name(), libmutter_api_version)
 
@@ -738,6 +739,7 @@ meson.add_dist_script('meson/check-version.py', meson.project_version(), 'NEWS')
 summary('prefix', prefix, section: 'Directories')
 summary('libexecdir', libexecdir, section: 'Directories')
 summary('pkgdatadir', pkgdatadir, section: 'Directories')
+summary('mandir', mandir, section: 'Directories')
 
 summary('buildtype', get_option('buildtype'), section: 'Build Configuration')
 summary('debug', get_option('debug'), section: 'Build Configuration')