Mercurial > projects > pwm
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 27:722a45b4028b | 28:e3db02d7f1f4 |
|---|---|
| 32 <surname>Berhoerster</surname> | 32 <surname>Berhoerster</surname> |
| 33 </personname> | 33 </personname> |
| 34 <email>guido+pwm@berhoerster.name</email> | 34 <email>guido+pwm@berhoerster.name</email> |
| 35 <personblurb/> | 35 <personblurb/> |
| 36 </author> | 36 </author> |
| 37 <date>25 September, 2017</date> | 37 <date>27 September, 2017</date> |
| 38 </info> | 38 </info> |
| 39 <refmeta> | 39 <refmeta> |
| 40 <refentrytitle>pwm</refentrytitle> | 40 <refentrytitle>pwm</refentrytitle> |
| 41 <manvolnum>1</manvolnum> | 41 <manvolnum>1</manvolnum> |
| 42 <refmiscinfo class="source"/> | 42 <refmiscinfo class="source"/> |
| 136 from stdin until either an error occurrs or end-of-file is reached.</para> | 136 from stdin until either an error occurrs or end-of-file is reached.</para> |
| 137 <para><command>pwm</command> operates on a copy of the password database | 137 <para><command>pwm</command> operates on a copy of the password database |
| 138 in memory, any changes must be explicitly written back to the database | 138 in memory, any changes must be explicitly written back to the database |
| 139 using the write command.</para> | 139 using the write command.</para> |
| 140 <refsect2> | 140 <refsect2> |
| 141 <title>Configuration Variables</title> | |
| 142 <para><command>pwm</command> can be configured through configuration | |
| 143 variables using the <command>set</command> command. The following | |
| 144 configuration variables are supported:</para> | |
| 145 <variablelist> | |
| 146 <varlistentry> | |
| 147 <term>filename</term> | |
| 148 <listitem> | |
| 149 <para>Specifies the password database file if no other file is | |
| 150 given as a command line argument.</para> | |
| 151 </listitem> | |
| 152 </varlistentry> | |
| 153 <varlistentry> | |
| 154 <term>pipecommand</term> | |
| 155 <listitem> | |
| 156 <para>Specifies a default command which is invoked by the | |
| 157 <command>pipe</command> command if not other command is | |
| 158 explicitly specified as a argument.</para> | |
| 159 </listitem> | |
| 160 </varlistentry> | |
| 161 </variablelist> | |
| 162 </refsect2> | |
| 163 <refsect2> | |
| 141 <title>IDs</title> | 164 <title>IDs</title> |
| 142 <para>Database entries are referred to by an ID value which is a | 165 <para>Database entries are referred to by an ID value which is a |
| 143 positive integer value that is guaranteed to be unqiue during the run | 166 positive integer value that is guaranteed to be unqiue during the run |
| 144 time of the pwm utility.</para> | 167 time of the pwm utility.</para> |
| 145 </refsect2> | 168 </refsect2> |
| 372 invoking the <command>sh</command> utility with the <arg>-c</arg> | 395 invoking the <command>sh</command> utility with the <arg>-c</arg> |
| 373 option and <replaceable>command</replaceable> as its option | 396 option and <replaceable>command</replaceable> as its option |
| 374 argument, thus special care should be applied to quoting command. | 397 argument, thus special care should be applied to quoting command. |
| 375 See the <citerefentry><refentrytitle>sh</refentrytitle> | 398 See the <citerefentry><refentrytitle>sh</refentrytitle> |
| 376 <manvolnum>1</manvolnum></citerefentry> manual page for | 399 <manvolnum>1</manvolnum></citerefentry> manual page for |
| 377 details.</para> | 400 details. The <replaceable>command</replaceable> argument is |
| 401 optional if the pipecommand configuration variable is set.</para> | |
| 378 </listitem> | 402 </listitem> |
| 379 </varlistentry> | 403 </varlistentry> |
| 380 <varlistentry> | 404 <varlistentry> |
| 381 <term>Create empty group</term> | 405 <term>Create empty group</term> |
| 382 <listitem> | 406 <listitem> |
| 508 previously tokenized contents before the command is | 532 previously tokenized contents before the command is |
| 509 evaluated.</para> | 533 evaluated.</para> |
| 510 </listitem> | 534 </listitem> |
| 511 </varlistentry> | 535 </varlistentry> |
| 512 <varlistentry> | 536 <varlistentry> |
| 537 <term>Set configuration variable or display their values</term> | |
| 538 <listitem> | |
| 539 <cmdsynopsis> | |
| 540 <command>set</command> | |
| 541 <arg choice="opt"> | |
| 542 <replaceable>variable</replaceable>=<replaceable>value</replaceable> | |
| 543 </arg> | |
| 544 </cmdsynopsis> | |
| 545 <cmdsynopsis> | |
| 546 <command>S</command> | |
| 547 <arg choice="plain"> | |
| 548 <replaceable>variable</replaceable>=<replaceable>value</replaceable> | |
| 549 </arg> | |
| 550 <sbr/> | |
| 551 </cmdsynopsis> | |
| 552 <para>If <replaceable>variable</replaceable> is specified, set the | |
| 553 configuration variable <replaceable>variable</replaceable> | |
| 554 to <replaceable>value</replaceable>. If no arguments are specified, | |
| 555 display the current values of all configuration variables.</para> | |
| 556 </listitem> | |
| 557 </varlistentry> | |
| 558 <varlistentry> | |
| 513 <term>Display help text</term> | 559 <term>Display help text</term> |
| 514 <listitem> | 560 <listitem> |
| 515 <cmdsynopsis> | 561 <cmdsynopsis> |
| 516 <command>help</command> | 562 <command>help</command> |
| 517 <arg choice="opt"> | 563 <arg choice="opt"> |