diff pwm.1.xml @ 29:00d782cb45fa

Read configuration file on startup
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Thu, 28 Sep 2017 10:06:59 +0200
parents e3db02d7f1f4
children
line wrap: on
line diff
--- a/pwm.1.xml	Wed Sep 27 19:44:05 2017 +0200
+++ b/pwm.1.xml	Thu Sep 28 10:06:59 2017 +0200
@@ -125,18 +125,27 @@
   </refsect1>
   <refsect1>
     <title>Usage</title>
-    <para>If stdin is connected to a terminal pwm will run in interactive mode
-    and prompt the user for the master password unless
-    <replaceable>password_file</replaceable> is specified via the
-    <option>-P</option> option. After successfully opening the password
-    database the user will be prompted for a command.</para>
-    <para>When running in non-interactive mode a file containing the master
-    pasword must be specified via the <option>-P</option> option and after
-    successfully opening the password database, pwm will execute commands read
-    from stdin until either an error occurrs or end-of-file is reached.</para>
-    <para><command>pwm</command> operates on a copy of the password database
-    in memory, any changes must be explicitly written back to the database
-    using the write command.</para>
+    <refsect2>
+      <title>Start-up</title>
+      <para>If stdin is connected to a terminal pwm will run in interactive mode
+      and prompt the user for the master password unless
+      <replaceable>password_file</replaceable> is specified via the
+      <option>-P</option> option. After successfully opening the password
+      database the user will be prompted for a command.</para>
+      <para>When running in non-interactive mode a file containing the master
+      pasword must be specified via the <option>-P</option> option and after
+      successfully opening the password database, pwm will execute commands
+      read from stdin until either an error occurrs or end-of-file is
+      reached.</para>
+      <para><command>pwm</command> operates on a copy of the password database
+      in memory, any changes must be explicitly written back to the database
+      using the write command.</para>
+      <para>When starting up, before prompting the user for a master password
+      or reading the master password from a specified file
+      <command>pwm</command> will read the file
+      <filename>~/.pwm/pwmrc</filename> and execute any <command>set</command>
+      and <command>define</command> commands specified therein.</para>
+    </refsect2>
     <refsect2>
       <title>Configuration Variables</title>
       <para><command>pwm</command> can be configured through configuration
@@ -732,6 +741,12 @@
     <title>Files</title>
     <variablelist>
       <varlistentry>
+        <term><filename>~/.pwm/pwmrc</filename></term>
+        <listitem>
+          <para>configuration file</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><filename>~/.pwm/pwm.psafe3</filename></term>
         <listitem>
           <para>default password database</para>