Blame SOURCES/0001-Add-a-manual.patch

9d45eb
From 33c56bac4d5592e845a824f3273de5af5eee0ae4 Mon Sep 17 00:00:00 2001
9d45eb
From: Debarshi Ray <debarshir@gnome.org>
9d45eb
Date: Wed, 17 Jun 2020 12:59:48 +0200
9d45eb
Subject: [PATCH] Add a manual
9d45eb
9d45eb
https://gitlab.gnome.org/GNOME/gnome-terminal/-/issues/277
9d45eb
---
9d45eb
 Makefile.am            |   2 +-
9d45eb
 configure.ac           |   9 +
9d45eb
 man/Makefile.am        |  18 ++
9d45eb
 man/gnome-terminal.xml | 385 +++++++++++++++++++++++++++++++++++++++++
9d45eb
 4 files changed, 413 insertions(+), 1 deletion(-)
9d45eb
 create mode 100644 man/Makefile.am
9d45eb
 create mode 100644 man/gnome-terminal.xml
9d45eb
9d45eb
diff --git a/Makefile.am b/Makefile.am
9d45eb
index 14b59bac43b9..52dd7265d715 100644
9d45eb
--- a/Makefile.am
9d45eb
+++ b/Makefile.am
9d45eb
@@ -1,4 +1,4 @@
9d45eb
-SUBDIRS = src po help
9d45eb
+SUBDIRS = man src po help
9d45eb
 
9d45eb
 NULL =
9d45eb
 
9d45eb
diff --git a/configure.ac b/configure.ac
9d45eb
index c5f40c07884a..00028858c654 100644
9d45eb
--- a/configure.ac
9d45eb
+++ b/configure.ac
9d45eb
@@ -192,6 +192,14 @@ if test -z "$DESKTOP_FILE_VALIDATE"; then
9d45eb
   fi
9d45eb
 fi
9d45eb
 
9d45eb
+AC_ARG_VAR([XSLTPROC],[the xsltproc programme])
9d45eb
+if test -z "$XSLTPROC"; then
9d45eb
+  AC_PATH_PROG([XSLTPROC],[xsltproc],[])
9d45eb
+  if test -z "$XSLTPROC"; then
9d45eb
+    AC_MSG_ERROR([xsltproc not found])
9d45eb
+  fi
9d45eb
+fi
9d45eb
+
9d45eb
 # ***************************
9d45eb
 # GNOME Shell search provider
9d45eb
 # ***************************
9d45eb
@@ -327,6 +335,7 @@ AC_DEFINE_UNQUOTED([GDK_VERSION_MAX_ALLOWED],[G_ENCODE_VERSION($(echo $GTK_MAX_A
9d45eb
 AC_CONFIG_FILES([
9d45eb
 Makefile
9d45eb
 org.gnome.Terminal.desktop.in
9d45eb
+man/Makefile
9d45eb
 src/Makefile
9d45eb
 src/terminal-version.h
9d45eb
 help/Makefile
9d45eb
diff --git a/man/Makefile.am b/man/Makefile.am
9d45eb
new file mode 100644
9d45eb
index 000000000000..ecce224d455d
9d45eb
--- /dev/null
9d45eb
+++ b/man/Makefile.am
9d45eb
@@ -0,0 +1,18 @@
9d45eb
+XSLTPROC_FLAGS = \
9d45eb
+        --nonet \
9d45eb
+        --stringparam man.output.quietly 1 \
9d45eb
+        --stringparam funcsynopsis.style ansi \
9d45eb
+        --stringparam man.authors.section.enabled 0 \
9d45eb
+        --stringparam man.copyright.section.enabled 0
9d45eb
+
9d45eb
+.xml.1:
9d45eb
+	$(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
9d45eb
+
9d45eb
+man_MANS = \
9d45eb
+	gnome-terminal.1
9d45eb
+
9d45eb
+xml_files = $(man_MANS:.1=.xml)
9d45eb
+
9d45eb
+EXTRA_DIST = $(xml_files)
9d45eb
+
9d45eb
+CLEANFILES = $(man_MANS)
9d45eb
diff --git a/man/gnome-terminal.xml b/man/gnome-terminal.xml
9d45eb
new file mode 100644
9d45eb
index 000000000000..abdac002c8ae
9d45eb
--- /dev/null
9d45eb
+++ b/man/gnome-terminal.xml
9d45eb
@@ -0,0 +1,385 @@
9d45eb
+
9d45eb
+
9d45eb
+  Copyright © 2020 Red Hat, Inc.
9d45eb
+
9d45eb
+  This program is free software; you can redistribute it and/or modify
9d45eb
+  it under the terms of either:
9d45eb
+
9d45eb
+  * the GNU General Public License as published by the Free
9d45eb
+    Software Foundation; either version 3 of the License, or (at your
9d45eb
+    option) any later version.
9d45eb
+
9d45eb
+  or
9d45eb
+
9d45eb
+  * the GNU Free Documentation License version 1.3 as published by the
9d45eb
+    Free Software Foundation; with no Invariant Sections, no Front-Cover
9d45eb
+    Texts, and no Back-Cover Texts.
9d45eb
+
9d45eb
+  or both in parallel, as here.
9d45eb
+
9d45eb
+  This program is distributed in the hope that it will be useful,
9d45eb
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
9d45eb
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9d45eb
+  GNU General Public License and the GNU Free Documentation License
9d45eb
+  for more details.
9d45eb
+
9d45eb
+  You should have received a copy of the GNU General Public License and
9d45eb
+  of the GNU Free Documentation License along with this program.
9d45eb
+  If not, see <https://www.gnu.org/licenses/>.
9d45eb
+-->
9d45eb
+<refentry id="gnome-terminal.1">
9d45eb
+  <refentryinfo>
9d45eb
+    <title>gnome-terminal</title>
9d45eb
+    <date>June 2020</date>
9d45eb
+    <productname>GNOME</productname>
9d45eb
+  </refentryinfo>
9d45eb
+
9d45eb
+  <refmeta>
9d45eb
+    <refentrytitle>gnome-terminal</refentrytitle>
9d45eb
+    <manvolnum>1</manvolnum>
9d45eb
+    <refmiscinfo class="manual">User Commands</refmiscinfo>
9d45eb
+  </refmeta>
9d45eb
+
9d45eb
+  <refnamediv>
9d45eb
+    <refname>gnome-terminal</refname>
9d45eb
+    <refpurpose>A terminal emulator for GNOME</refpurpose>
9d45eb
+  </refnamediv>
9d45eb
+
9d45eb
+  <refsynopsisdiv>
9d45eb
+    <cmdsynopsis>
9d45eb
+      <command>gnome-terminal</command>
9d45eb
+    </cmdsynopsis>
9d45eb
+  </refsynopsisdiv>
9d45eb
+
9d45eb
+
9d45eb
+  <refsect1>
9d45eb
+    <title>DESCRIPTION</title>
9d45eb
+    <para>
9d45eb
+      <command>gnome-terminal</command> is a terminal emulator application for
9d45eb
+      accessing a UNIX shell environment which can be used to run programs
9d45eb
+      available on your system. It supports several profiles, multiple tabs and
9d45eb
+      implements several keyboard shortcuts.
9d45eb
+    </para>
9d45eb
+  </refsect1>
9d45eb
+
9d45eb
+  <refsect1>
9d45eb
+    <title>OPTIONS</title>
9d45eb
+    <variablelist>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help, -h</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show a brief overview of all the options.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help-all</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show all the options in detail.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help-gtk</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show all the GTK options.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help-terminal</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show all the options to select between new terminal tabs or
9d45eb
+            windows.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help-terminal-options</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show all the options to change the attributes of terminals
9d45eb
+            regardless of whether they are in separate tabs or windows.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--help-window-options</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show all the options to change the attributes of windows
9d45eb
+            containing terminals.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--load-config=FILE</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Restore the application to a previously saved state by loading it
9d45eb
+            from a configuration file.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--preferences</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Show the preferences window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--print-environment, -p</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Print the environment variables to interact with newly created
9d45eb
+            terminals.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--quiet, -q</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Suppress diagnostics.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--verbose, -v</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Increase diagnostic verbosity.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--tab</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Open a new tab containing a terminal in the last-opened window with
9d45eb
+            the default profile.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--window</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Open a new window with a tab containing a terminal with the default
9d45eb
+            profile.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--command, -e=COMMAND</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Execute the argument to this option inside the terminal.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--fd=FD</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Forward file descriptor.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--profile=PROFILE-NAME</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Use the given profile instead of the default profile.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--title, -t=TITLE</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the initial terminal title.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--wait</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Wait until the terminal's child exits.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--working-directory=DIRNAME</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the terminal's working directory.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--zoom=ZOOM</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the terminal's zoom factor. 1.0 is normal size.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--active</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the last specified tab as the active one in its window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--full-screen</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Full-screen the window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--geometry=GEOMETRY</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the window size as COLSxROWS+X+Y. For example, 80x24 or
9d45eb
+            80x24+200+200.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--hide-menubar</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Turn off the menubar for the window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--show-menubar</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Turn on the menubar for the window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--maximize</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Maximize the window.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--role=ROLE</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Set the X window role.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--class=CLASS</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Program class as used by the window manager.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--display=DISPLAY</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            X display to use.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--g-fatal-warnings</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Make all warnings fatal.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--gdk-debug=FLAGS</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            GDK debugging flags to set.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--gdk-no-debug=FLAGS</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            GDK debugging flags to unset.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--gtk-debug=FLAGS</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            GTK debugging flags to set.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--gtk-no-debug=FLAGS</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            GTK debugging flags to unset.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--gtk-module=MODULES</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Load additional GTK modules.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+      <varlistentry>
9d45eb
+        <term><option>--name=NAME</option></term>
9d45eb
+        <listitem>
9d45eb
+          <para>
9d45eb
+            Program name as used by the window manager.
9d45eb
+          </para>
9d45eb
+        </listitem>
9d45eb
+      </varlistentry>
9d45eb
+    </variablelist>
9d45eb
+  </refsect1>
9d45eb
+
9d45eb
+  <refsect1>
9d45eb
+    <title>BUGS</title>
9d45eb
+    <para>
9d45eb
+      Please read
9d45eb
+      <ulink url="https://wiki.gnome.org/Apps/Terminal/ReportingBugs"></ulink>
9d45eb
+      on how to report bugs.
9d45eb
+    </para>
9d45eb
+  </refsect1>
9d45eb
+
9d45eb
+  <refsect1>
9d45eb
+    <title>SEE ALSO</title>
9d45eb
+    <para>
9d45eb
+      For further information, visit the website
9d45eb
+      <ulink url="https://wiki.gnome.org/Apps/Terminal"></ulink>. There's a
9d45eb
+      list of frequently asked questions at
9d45eb
+      <ulink url="https://wiki.gnome.org/Apps/Terminal/FAQ"></ulink>.
9d45eb
+    </para>
9d45eb
+  </refsect1>
9d45eb
+</refentry>
9d45eb
-- 
9d45eb
2.25.4
9d45eb