From be392fbc10841af85924fa5ee46ef5db0387e9a6 Mon Sep 17 00:00:00 2001
From: Colin Clark <colin.clark@cclark.uk>
Date: Fri, 27 Oct 2023 11:30:46 +0100
Subject: [PATCH] Document XDG_* options for --new-instance

Update the man page and ref. document to include:

When the --remote-instance option is used, a single set of configuration
files is used for all instances.
However, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME,
XDG_DATA_HOME can be used to modify this behavior on an individual basis
e.g.

XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie
---
 doc/docbook/CommandLineOptions.xml | 12 +++++++++---
 geeqie.1                           | 12 +++++++++---
 src/main.cc                        |  3 ++-
 3 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/doc/docbook/CommandLineOptions.xml b/doc/docbook/CommandLineOptions.xml
index e3acac0a..fb7adecd 100644
--- a/doc/docbook/CommandLineOptions.xml
+++ b/doc/docbook/CommandLineOptions.xml
@@ -8,7 +8,7 @@
 <refentrytitle>GEEQIE</refentrytitle>
 <manvolnum>1</manvolnum>
 <refmiscinfo class='source'>October 2023</refmiscinfo>
-<refmiscinfo class='manual'>Geeqie 2.1+git20231016-1a72d946 GTK3</refmiscinfo>
+<refmiscinfo class='manual'>Geeqie 2.1+git20231026-2338cf60 GTK3</refmiscinfo>
 </refmeta>
 <refnamediv>
 <refname>Geeqie</refname>
@@ -30,7 +30,7 @@ zooming, panning, thumbnails and sorting images into collections.</para>
 
 <para>Generated for version:</para>
 
-<para>Geeqie 2.1+git20231016-1a72d946</para>
+<para>Geeqie 2.1+git20231026-2338cf60</para>
 
 <refsect2 id='valid_options'><title>Valid options:</title>
 <variablelist remap='TP'>
@@ -77,7 +77,7 @@ zooming, panning, thumbnails and sorting images into collections.</para>
   <varlistentry>
   <term><emphasis role='strong' remap='B'>-n</emphasis>, <emphasis role='strong' remap='B'>--new-instance</emphasis></term>
   <listitem>
-<para>open a new instance of Geeqie</para>
+<para>open a new instance of Geeqie *</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -141,6 +141,12 @@ zooming, panning, thumbnails and sorting images into collections.</para>
   </listitem>
   </varlistentry>
 </variablelist>
+
+<para>* Normally a single set of configuration files is used for all instances.
+However, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME, XDG_DATA_HOME
+can be used to modify this behavior on an individual basis e.g.</para>
+
+<para>XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie</para>
 </refsect2>
 
 <refsect2 id='remote_command_list'><title>Remote command list:</title>
diff --git a/geeqie.1 b/geeqie.1
index a8bcf256..502776fd 100644
--- a/geeqie.1
+++ b/geeqie.1
@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
-.TH GEEQIE "1" "October 2023" "Geeqie 2.1+git20231016-1a72d946 GTK3" "User Commands"
+.TH GEEQIE "1" "October 2023" "Geeqie 2.1+git20231026-2338cf60 GTK3" "User Commands"
 .SH NAME
 Geeqie - GTK based multiformat image viewer
 .SH SYNOPSIS
@@ -11,7 +11,7 @@ zooming, panning, thumbnails and sorting images into collections.
 
 Generated for version:
 .PP
-Geeqie 2.1+git20231016\-1a72d946
+Geeqie 2.1+git20231026\-2338cf60
 .SS "Valid options:"
 .TP
 \fB\-\-blank\fR
@@ -35,7 +35,7 @@ show this message
 \fB\-l\fR, \fB\-\-list\fR [files] [collections] open collection window for command line
 .TP
 \fB\-n\fR, \fB\-\-new\-instance\fR
-open a new instance of Geeqie
+open a new instance of Geeqie *
 .TP
 \fB\-o\fR:, \fB\-\-log\-file\fR:<file>
 save log data to file
@@ -66,6 +66,12 @@ turn on debug output
 .TP
 \fB\-g\fR:, \fB\-\-grep\fR:<regexp>
 filter debug output
+.PP
+* Normally a single set of configuration files is used for all instances.
+However, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME, XDG_DATA_HOME
+can be used to modify this behavior on an individual basis e.g.
+.PP
+XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie
 .SS "Remote command list:"
 .TP
 \fB\-\-action\fR:<ACTION>
diff --git a/src/main.cc b/src/main.cc
index 7e0857e0..7e361d0f 100644
--- a/src/main.cc
+++ b/src/main.cc
@@ -516,7 +516,7 @@ static void parse_command_line(gint argc, gchar *argv[])
 				print_term(FALSE, _("      --geometry=WxH+XOFF+YOFF     set main window location\n"));
 				print_term(FALSE, _("  -h, --help                       show this message\n"));
 				print_term(FALSE, _("  -l, --list [files] [collections] open collection window for command line\n"));
-				print_term(FALSE, _("  -n, --new-instance               open a new instance of Geeqie\n"));
+				print_term(FALSE, _("  -n, --new-instance               open a new instance of Geeqie *\n"));
 				print_term(FALSE, _("  -o:, --log-file:<file>           save log data to file\n"));
 				print_term(FALSE, _("  -r, --remote                     send following commands to open window\n"));
 				print_term(FALSE, _("  -rh, --remote-help               print remote command list\n"));
@@ -531,6 +531,7 @@ static void parse_command_line(gint argc, gchar *argv[])
 #endif
 
 				print_term(FALSE, "\n");
+				print_term(FALSE, "* Normally a single set of configuration files is used for all instances.\nHowever, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME, XDG_DATA_HOME\ncan be used to modify this behavior on an individual basis e.g.\n\nXDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie\n\n");
 
 				remote_help();
 
-- 
2.20.1