summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2019-01-21 12:42:45 -0500
committerMatthias Clasen <mclasen@redhat.com>2019-01-22 13:18:50 -0500
commit8f71892862c86e7dc65d334b9573a658d94147ce (patch)
tree3e5f3fa8d8c89f2188890dfeb78fb6723d517a17
parentdf5b482781b4c465c19447d0c43cd26096d2252b (diff)
downloadglib-gio-extension-point-help.tar.gz
Document "help" for extensionsgio-extension-point-help
Mention the special value "help" for the environment variables that we document for picking extensions.
-rw-r--r--docs/reference/gio/overview.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/reference/gio/overview.xml b/docs/reference/gio/overview.xml
index f4c87b7d5..960cd2fc1 100644
--- a/docs/reference/gio/overview.xml
+++ b/docs/reference/gio/overview.xml
@@ -371,6 +371,9 @@ Gvfs is also heavily distributed and relies on a session bus to be present.
has the name "local", the implementation in the gvfs module has
the name "gvfs". Most commonly, system software will set this to "local"
to avoid having `GFile` APIs perform unnecessary DBus calls.
+ </para><para>
+ The special value <literal>help</literal> can be used to print a list of
+ available implementations to standard output.
</para>
</formalpara>
@@ -390,6 +393,9 @@ Gvfs is also heavily distributed and relies on a session bus to be present.
in GIO on Linux has the name "inotify", others that are built
are built as modules (depending on the platform) are called
"fam" and "fen".
+ </para><para>
+ The special value <literal>help</literal> can be used to print a list of
+ available implementations to standard output.
</para>
</formalpara>
@@ -402,6 +408,9 @@ Gvfs is also heavily distributed and relies on a session bus to be present.
The #GVolumeMonitor implementation for local files that is included
in GIO has the name "unix", the udisks2-based implementation in the
gvfs module has the name "udisks2".
+ </para><para>
+ The special value <literal>help</literal> can be used to print a list of
+ available implementations to standard output.
</para>
</formalpara>
@@ -413,6 +422,9 @@ Gvfs is also heavily distributed and relies on a session bus to be present.
implementation to override the default for debugging purposes.
GIO does not include a #GTlsBackend implementation, the gnutls-based
implementation in the glib-networking module has the name "gnutls".
+ </para><para>
+ The special value <literal>help</literal> can be used to print a list of
+ available implementations to standard output.
</para>
</formalpara>
@@ -444,6 +456,9 @@ Gvfs is also heavily distributed and relies on a session bus to be present.
implementation to override the default for debugging purposes.
The memory-based implementation that is included in GIO has
the name "memory", the one in dconf has the name "dconf".
+ </para><para>
+ The special value <literal>help</literal> can be used to print a list of
+ available implementations to standard output.
</para>
</formalpara>