Mercurial > projects > pwm

comparison pwm.1.xml @ 10:17fb30016e64

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Enable access to record and file metadata Add info command to show file metadata. Enable display of creation and modification dates of records.
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Fri, 28 Jul 2017 15:53:57 +0200
parents 55281f14dc9b
children 85bce13237cf
comparison
equal deleted inserted replaced
9:60c8ab006e55 10:17fb30016e64
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>3 February, 2017</date> 37 <date>28 July, 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"/>
78 database.</para> 78 database.</para>
79 <para><command>pwm</command> must be run with a locale which uses the UTF-8 79 <para><command>pwm</command> must be run with a locale which uses the UTF-8
80 character encoding.</para> 80 character encoding.</para>
81 <refsect2> 81 <refsect2>
82 <title>Output format</title> 82 <title>Output format</title>
83 <para>The <command>show</command> command displays selected fields by 83 <para>The <command>show</command> and <command>info</command> commands
84 printing the field name followed by a colon, one or more space characters 84 display fields by printing the field name followed by a colon, one or
85 and the field's verbatim content to the standard output stream. Field 85 more space characters and the field's verbatim content to the standard
86 values may contain newlines, non-printable and/or control 86 output stream. Field content may contain newlines, non-printable and/or
87 characters.</para> 87 control characters.</para>
88 <para>The <command>pipe</command> prints the verbatim field content to the 88 <para>The <command>pipe</command> prints the verbatim field content to the
89 standard input stream of the given command.</para> 89 standard input stream of the given command.</para>
90 <para>Error messages are printed to the standard error stream.</para> 90 <para>Error messages are printed to the standard error stream.</para>
91 </refsect2> 91 </refsect2>
92 </refsect1> 92 </refsect1>
126 positive integer value that is guaranteed to be unqiue during the run 126 positive integer value that is guaranteed to be unqiue during the run
127 time of the pwm utility.</para> 127 time of the pwm utility.</para>
128 </refsect2> 128 </refsect2>
129 <refsect2> 129 <refsect2>
130 <title>Fields</title> 130 <title>Fields</title>
131 <para>The following entry fields are supported: 131 <para>The following entry fields are supported:</para>
132 <simplelist type="vert"> 132 <table xml:id="field-table">
133 <member>group</member> 133 <title>Fields and their identifiers</title>
134 <member>title</member> 134 <tgroup cols="2" align="left" colsep="1" rowsep="1">
135 <member>username</member> 135 <thead>
136 <member>password</member> 136 <row>
137 <member>notes</member> 137 <entry>Field</entry>
138 <member>url</member> 138 <entry>Field Identifier</entry>
139 </simplelist> 139 </row>
140 </para> 140 </thead>
141 <tbody>
142 <row>
143 <entry>Group</entry>
144 <entry>group</entry>
145 </row>
146 <row>
147 <entry>Title</entry>
148 <entry>title</entry>
149 </row>
150 <row>
151 <entry>Username</entry>
152 <entry>username</entry>
153 </row>
154 <row>
155 <entry>Password</entry>
156 <entry>password</entry>
157 </row>
158 <row>
159 <entry>Notes</entry>
160 <entry>notes</entry>
161 </row>
162 <row>
163 <entry>URL</entry>
164 <entry>url</entry>
165 </row>
166 <row>
167 <entry>Creation Time</entry>
168 <entry>ctime</entry>
169 </row>
170 <row>
171 <entry>Modification Time</entry>
172 <entry>mtime</entry>
173 </row>
174 </tbody>
175 </tgroup>
176 </table>
141 <para>Other, existing fields specified by the PasswordSafe file format 177 <para>Other, existing fields specified by the PasswordSafe file format
142 will be preserved but cannot be displayed or modified.</para> 178 will be preserved but cannot be displayed or modified.</para>
143 </refsect2> 179 </refsect2>
144 <refsect2> 180 <refsect2>
145 <title>Commands</title> 181 <title>Commands</title>
372 </cmdsynopsis> 408 </cmdsynopsis>
373 <para>Display a list of all commands and a short help text.</para> 409 <para>Display a list of all commands and a short help text.</para>
374 </listitem> 410 </listitem>
375 </varlistentry> 411 </varlistentry>
376 <varlistentry> 412 <varlistentry>
413 <term>Show metadata information</term>
414 <listitem>
415 <cmdsynopsis>
416 <command>info</command>
417 </cmdsynopsis>
418 <cmdsynopsis>
419 <command>i</command>
420 <sbr/>
421 </cmdsynopsis>
422 <para>Display metadata information such as the user who last wrote
423 to the database, the time when the database was last written to,
424 and the host on which the password database was last written
425 to.</para>
426 </listitem>
427 </varlistentry>
428 <varlistentry>
377 <term>Write database</term> 429 <term>Write database</term>
378 <listitem> 430 <listitem>
379 <cmdsynopsis> 431 <cmdsynopsis>
380 <command>write</command> 432 <command>write</command>
381 </cmdsynopsis> 433 </cmdsynopsis>
419 <literal>LC_ALL</literal> 471 <literal>LC_ALL</literal>
420 </term> 472 </term>
421 <listitem> 473 <listitem>
422 <para>See <citerefentry><refentrytitle>locale</refentrytitle> 474 <para>See <citerefentry><refentrytitle>locale</refentrytitle>
423 <manvolnum>5</manvolnum></citerefentry></para> 475 <manvolnum>5</manvolnum></citerefentry></para>
476 </listitem>
477 </varlistentry>
478 <varlistentry>
479 <term>
480 <literal>LOGNAME</literal>
481 </term>
482 <listitem>
483 <para>The name of the logged in user which is recorded when writing
484 the password database</para>
424 </listitem> 485 </listitem>
425 </varlistentry> 486 </varlistentry>
426 </variablelist> 487 </variablelist>
427 </refsect1> 488 </refsect1>
428 <refsect1> 489 <refsect1>