|
 |
b320ff |
From 1565368816f7cb4b34be21f5ef47f73940d6cf04 Mon Sep 17 00:00:00 2001
|
|
|
b320ff |
From: Debarshi Ray <debarshir@gnome.org>
|
|
|
b320ff |
Date: Mon, 9 Nov 2020 23:42:46 +0100
|
|
|
b320ff |
Subject: [PATCH] Add a manual
|
|
|
b320ff |
|
|
|
b320ff |
https://gitlab.gnome.org/GNOME/gnome-photos/-/merge_requests/153
|
|
|
b320ff |
---
|
|
|
b320ff |
Makefile.am | 2 +-
|
|
|
b320ff |
configure.ac | 6 ++
|
|
|
b320ff |
manuals/Makefile.am | 18 ++++
|
|
|
b320ff |
manuals/gnome-photos.xml | 192 +++++++++++++++++++++++++++++++++++++++
|
|
|
b320ff |
4 files changed, 217 insertions(+), 1 deletion(-)
|
|
|
b320ff |
create mode 100644 manuals/Makefile.am
|
|
|
b320ff |
create mode 100644 manuals/gnome-photos.xml
|
|
|
b320ff |
|
|
|
b320ff |
diff --git a/Makefile.am b/Makefile.am
|
|
|
b320ff |
index 0c7d8bff0cf1..7b19e62f5d62 100644
|
|
|
b320ff |
--- a/Makefile.am
|
|
|
b320ff |
+++ b/Makefile.am
|
|
|
b320ff |
@@ -1,6 +1,6 @@
|
|
|
b320ff |
ACLOCAL_AMFLAGS = -I m4 -I libgd ${ACLOCAL_FLAGS}
|
|
|
b320ff |
|
|
|
b320ff |
-SUBDIRS = . data libgd src po tests help
|
|
|
b320ff |
+SUBDIRS = . data libgd manuals src po tests help
|
|
|
b320ff |
|
|
|
b320ff |
photosdocdir = $(docdir)
|
|
|
b320ff |
photosdoc_DATA = \
|
|
|
b320ff |
diff --git a/configure.ac b/configure.ac
|
|
|
b320ff |
index 904a031c6ec1..5d511bba1390 100644
|
|
|
b320ff |
--- a/configure.ac
|
|
|
b320ff |
+++ b/configure.ac
|
|
|
b320ff |
@@ -149,6 +149,11 @@ if test -z "$DESKTOP_FILE_VALIDATE"; then
|
|
|
b320ff |
AC_MSG_ERROR([desktop-file-validate not found])
|
|
|
b320ff |
fi
|
|
|
b320ff |
|
|
|
b320ff |
+AC_PATH_PROG([XSLTPROC],[xsltproc],[])
|
|
|
b320ff |
+if test -z "$XSLTPROC"; then
|
|
|
b320ff |
+ AC_MSG_ERROR([xsltproc not found])
|
|
|
b320ff |
+fi
|
|
|
b320ff |
+
|
|
|
b320ff |
#############################################
|
|
|
b320ff |
#Documentation
|
|
|
b320ff |
#############################################
|
|
|
b320ff |
@@ -163,6 +168,7 @@ data/org.gnome.Photos.desktop.in
|
|
|
b320ff |
data/icons/Makefile
|
|
|
b320ff |
help/Makefile
|
|
|
b320ff |
libgd/Makefile
|
|
|
b320ff |
+manuals/Makefile
|
|
|
b320ff |
src/Makefile
|
|
|
b320ff |
tests/Makefile
|
|
|
b320ff |
po/Makefile.in
|
|
|
b320ff |
diff --git a/manuals/Makefile.am b/manuals/Makefile.am
|
|
|
b320ff |
new file mode 100644
|
|
|
b320ff |
index 000000000000..508c3cea2701
|
|
|
b320ff |
--- /dev/null
|
|
|
b320ff |
+++ b/manuals/Makefile.am
|
|
|
b320ff |
@@ -0,0 +1,18 @@
|
|
|
b320ff |
+XSLTPROC_FLAGS = \
|
|
|
b320ff |
+ --nonet \
|
|
|
b320ff |
+ --stringparam funcsynopsis.style ansi \
|
|
|
b320ff |
+ --stringparam man.authors.section.enabled 0 \
|
|
|
b320ff |
+ --stringparam man.copyright.section.enabled 0 \
|
|
|
b320ff |
+ --stringparam man.output.quietly 1
|
|
|
b320ff |
+
|
|
|
b320ff |
+.xml.1:
|
|
|
b320ff |
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
|
|
b320ff |
+
|
|
|
b320ff |
+man_MANS = \
|
|
|
b320ff |
+ gnome-photos.1
|
|
|
b320ff |
+
|
|
|
b320ff |
+xml_files = $(man_MANS:.1=.xml)
|
|
|
b320ff |
+
|
|
|
b320ff |
+EXTRA_DIST = $(xml_files)
|
|
|
b320ff |
+
|
|
|
b320ff |
+CLEANFILES = $(man_MANS)
|
|
|
b320ff |
diff --git a/manuals/gnome-photos.xml b/manuals/gnome-photos.xml
|
|
|
b320ff |
new file mode 100644
|
|
|
b320ff |
index 000000000000..c370e31057c7
|
|
|
b320ff |
--- /dev/null
|
|
|
b320ff |
+++ b/manuals/gnome-photos.xml
|
|
|
b320ff |
@@ -0,0 +1,192 @@
|
|
|
b320ff |
+
|
|
|
b320ff |
+<refentry id="gnome-photos.1">
|
|
|
b320ff |
+ <refentryinfo>
|
|
|
b320ff |
+ <title>gnome-photos</title>
|
|
|
b320ff |
+ <date>November 2020</date>
|
|
|
b320ff |
+ <productname>GNOME</productname>
|
|
|
b320ff |
+ </refentryinfo>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refmeta>
|
|
|
b320ff |
+ <refentrytitle>gnome-photos</refentrytitle>
|
|
|
b320ff |
+ <manvolnum>1</manvolnum>
|
|
|
b320ff |
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
|
b320ff |
+ </refmeta>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refnamediv>
|
|
|
b320ff |
+ <refname>gnome-photos</refname>
|
|
|
b320ff |
+ <refpurpose>Access, organize and share your photos on GNOME</refpurpose>
|
|
|
b320ff |
+ </refnamediv>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refsynopsisdiv>
|
|
|
b320ff |
+ <cmdsynopsis>
|
|
|
b320ff |
+ <command>gnome-photos</command>
|
|
|
b320ff |
+ <group rep="repeat"><replaceable>OPTION</replaceable></group>
|
|
|
b320ff |
+ </cmdsynopsis>
|
|
|
b320ff |
+ </refsynopsisdiv>
|
|
|
b320ff |
+
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refsect1>
|
|
|
b320ff |
+ <title>DESCRIPTION</title>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ <command>gnome-photos</command> is an application to access, organize
|
|
|
b320ff |
+ and share your photos on GNOME. A simple and elegant replacement for
|
|
|
b320ff |
+ using a file manager to deal with photos. Enhance, crop and edit in a
|
|
|
b320ff |
+ snap. Seamless cloud integration is offered through GNOME Online
|
|
|
b320ff |
+ Accounts.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </refsect1>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refsect1>
|
|
|
b320ff |
+ <title>OPTIONS</title>
|
|
|
b320ff |
+ <variablelist>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--help, -h</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show a brief overview of all the options.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--help-all</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show all the options in detail.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--help-gapplication</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show all the GApplication options.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--help-gtk</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show all the GTK options.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--empty-results</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show the empty state.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--version</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Show the application's version.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gapplication-service</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Enter GApplication service mode. To be used from D-Bus service
|
|
|
b320ff |
+ files.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--class=CLASS</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Program class as used by the window manager.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--display=DISPLAY</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ X display to use.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--g-fatal-warnings</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Make all warnings fatal.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gdk-debug=FLAGS</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ GDK debugging flags to set.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gdk-no-debug=FLAGS</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ GDK debugging flags to unset.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gtk-debug=FLAGS</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ GTK debugging flags to set.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gtk-no-debug=FLAGS</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ GTK debugging flags to unset.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--gtk-module=MODULES</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Load additional GTK modules.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ <varlistentry>
|
|
|
b320ff |
+ <term><option>--name=NAME</option></term>
|
|
|
b320ff |
+ <listitem>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Program name as used by the window manager.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </listitem>
|
|
|
b320ff |
+ </varlistentry>
|
|
|
b320ff |
+ </variablelist>
|
|
|
b320ff |
+ </refsect1>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refsect1>
|
|
|
b320ff |
+ <title>BUGS</title>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ Please send bug reports to either the distribution bug tracker or the
|
|
|
b320ff |
+ upstream bug tracker at
|
|
|
b320ff |
+ <ulink url="https://gitlab.gnome.org/GNOME/gnome-photos/issues"></ulink>.
|
|
|
b320ff |
+ There are some debugging tips at
|
|
|
b320ff |
+ <ulink url="https://wiki.gnome.org/Apps/Photos/Debugging"></ulink>
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </refsect1>
|
|
|
b320ff |
+
|
|
|
b320ff |
+ <refsect1>
|
|
|
b320ff |
+ <title>SEE ALSO</title>
|
|
|
b320ff |
+ <para>
|
|
|
b320ff |
+ For further information, visit the website
|
|
|
b320ff |
+ <ulink url="https://wiki.gnome.org/Apps/Photos"></ulink>.
|
|
|
b320ff |
+ </para>
|
|
|
b320ff |
+ </refsect1>
|
|
|
b320ff |
+</refentry>
|
|
|
b320ff |
--
|
|
|
b320ff |
2.28.0
|
|
|
b320ff |
|