From 17ea60eaf9d1b4eab9546d6dfc7e7afe83779f91 Mon Sep 17 00:00:00 2001
From: Stef Walter <stef@thewalter.net>
Date: Tue, 24 Jun 2014 13:34:20 +0200
Subject: p11-kit: Cleanup and add documentation for 'remote' option

https://bugs.freedesktop.org/show_bug.cgi?id=54105
---
 doc/manual/p11-kit.xml     | 15 +++++++++++++++
 doc/manual/pkcs11.conf.xml | 13 +++++++++++++
 2 files changed, 28 insertions(+)

(limited to 'doc')

diff --git a/doc/manual/p11-kit.xml b/doc/manual/p11-kit.xml
index bc618f9..be3f982 100644
--- a/doc/manual/p11-kit.xml
+++ b/doc/manual/p11-kit.xml
@@ -93,6 +93,21 @@ $ p11-kit list-modules
 	for more information</para>
 </refsect1>
 
+<refsect1 id="p11-kit-remote">
+	<title>Remote</title>
+
+	<para>Run a PKCS#11 module remotely.</para>
+
+<programlisting>
+$ p11-kit remote /path/to/pkcs11-module.so
+</programlisting>
+
+	<para>This is not meant to be run directly from a terminal. But rather in a
+	<option>remote</option> option in a
+	<citerefentry><refentrytitle>pkcs11.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+	file.</para>
+</refsect1>
+
 <refsect1 id="p11-kit-bugs">
   <title>Bugs</title>
   <para>
diff --git a/doc/manual/pkcs11.conf.xml b/doc/manual/pkcs11.conf.xml
index 0b61b6f..2617677 100644
--- a/doc/manual/pkcs11.conf.xml
+++ b/doc/manual/pkcs11.conf.xml
@@ -155,6 +155,19 @@ x-custom : text
 		</listitem>
 	</varlistentry>
 	<varlistentry>
+		<term><option>remote:</option></term>
+		<listitem>
+			<para>Instead of loading the PKCS#11 module locally, run the module
+			remotely.</para>
+			<para>Specify a command to run, prefixed with <literal>|</literal> a pipe.
+			The command must speak the p11-kit remoting protocol on its standard in
+			and standard out. For example:</para>
+<programlisting>
+remote: |ssh user@remote p11-kit remote /path/to/module.so
+</programlisting>
+		</listitem>
+	</varlistentry>
+	<varlistentry>
 		<term><option>trust-policy:</option></term>
 		<listitem>
 			<para>Set to <literal>yes</literal> to use use this module as a source
-- 
cgit v1.1