diff pwm.1.xml @ 28:e3db02d7f1f4

Add set command for setting or retrieving option values
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Wed, 27 Sep 2017 19:44:05 +0200
parents 722a45b4028b
children 00d782cb45fa
line wrap: on
line diff
--- a/pwm.1.xml	Mon Sep 25 21:21:25 2017 +0200
+++ b/pwm.1.xml	Wed Sep 27 19:44:05 2017 +0200
@@ -34,7 +34,7 @@
       <email>guido+pwm@berhoerster.name</email>
       <personblurb/>
     </author>
-    <date>25 September, 2017</date>
+    <date>27 September, 2017</date>
   </info>
   <refmeta>
     <refentrytitle>pwm</refentrytitle>
@@ -138,6 +138,29 @@
     in memory, any changes must be explicitly written back to the database
     using the write command.</para>
     <refsect2>
+      <title>Configuration Variables</title>
+      <para><command>pwm</command> can be configured through configuration
+      variables using the <command>set</command> command. The following
+      configuration variables are supported:</para>
+      <variablelist>
+        <varlistentry>
+          <term>filename</term>
+          <listitem>
+            <para>Specifies the password database file if no other file is
+            given as a command line argument.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>pipecommand</term>
+          <listitem>
+            <para>Specifies a default command which is invoked by the
+            <command>pipe</command> command if not other command is
+            explicitly specified as a argument.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+    <refsect2>
       <title>IDs</title>
       <para>Database entries are referred to by an ID value which is a
       positive integer value that is guaranteed to be unqiue during the run
@@ -374,7 +397,8 @@
             argument, thus special care should be applied to quoting command.
             See the <citerefentry><refentrytitle>sh</refentrytitle>
             <manvolnum>1</manvolnum></citerefentry> manual page for
-            details.</para>
+            details. The <replaceable>command</replaceable> argument is
+            optional if the pipecommand configuration variable is set.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
@@ -510,6 +534,28 @@
           </listitem>
         </varlistentry>
         <varlistentry>
+          <term>Set configuration variable or display their values</term>
+          <listitem>
+            <cmdsynopsis>
+              <command>set</command>
+              <arg choice="opt">
+                <replaceable>variable</replaceable>=<replaceable>value</replaceable>
+              </arg>
+            </cmdsynopsis>
+            <cmdsynopsis>
+              <command>S</command>
+              <arg choice="plain">
+                <replaceable>variable</replaceable>=<replaceable>value</replaceable>
+              </arg>
+              <sbr/>
+            </cmdsynopsis>
+            <para>If <replaceable>variable</replaceable> is specified, set the
+            configuration variable <replaceable>variable</replaceable>
+            to <replaceable>value</replaceable>. If no arguments are specified,
+            display the current values of all configuration variables.</para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
           <term>Display help text</term>
           <listitem>
             <cmdsynopsis>