Mercurial > projects > pwm
diff pwm.1.xml @ 10:17fb30016e64
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 |
line wrap: on
line diff
--- a/pwm.1.xml Fri Jul 28 09:53:46 2017 +0200 +++ b/pwm.1.xml Fri Jul 28 15:53:57 2017 +0200 @@ -34,7 +34,7 @@ <email>guido+pwm@berhoerster.name</email> <personblurb/> </author> - <date>3 February, 2017</date> + <date>28 July, 2017</date> </info> <refmeta> <refentrytitle>pwm</refentrytitle> @@ -80,11 +80,11 @@ character encoding.</para> <refsect2> <title>Output format</title> - <para>The <command>show</command> command displays selected fields by - printing the field name followed by a colon, one or more space characters - and the field's verbatim content to the standard output stream. Field - values may contain newlines, non-printable and/or control - characters.</para> + <para>The <command>show</command> and <command>info</command> commands + display fields by printing the field name followed by a colon, one or + more space characters and the field's verbatim content to the standard + output stream. Field content may contain newlines, non-printable and/or + control characters.</para> <para>The <command>pipe</command> prints the verbatim field content to the standard input stream of the given command.</para> <para>Error messages are printed to the standard error stream.</para> @@ -128,16 +128,52 @@ </refsect2> <refsect2> <title>Fields</title> - <para>The following entry fields are supported: - <simplelist type="vert"> - <member>group</member> - <member>title</member> - <member>username</member> - <member>password</member> - <member>notes</member> - <member>url</member> - </simplelist> - </para> + <para>The following entry fields are supported:</para> + <table xml:id="field-table"> + <title>Fields and their identifiers</title> + <tgroup cols="2" align="left" colsep="1" rowsep="1"> + <thead> + <row> + <entry>Field</entry> + <entry>Field Identifier</entry> + </row> + </thead> + <tbody> + <row> + <entry>Group</entry> + <entry>group</entry> + </row> + <row> + <entry>Title</entry> + <entry>title</entry> + </row> + <row> + <entry>Username</entry> + <entry>username</entry> + </row> + <row> + <entry>Password</entry> + <entry>password</entry> + </row> + <row> + <entry>Notes</entry> + <entry>notes</entry> + </row> + <row> + <entry>URL</entry> + <entry>url</entry> + </row> + <row> + <entry>Creation Time</entry> + <entry>ctime</entry> + </row> + <row> + <entry>Modification Time</entry> + <entry>mtime</entry> + </row> + </tbody> + </tgroup> + </table> <para>Other, existing fields specified by the PasswordSafe file format will be preserved but cannot be displayed or modified.</para> </refsect2> @@ -374,6 +410,22 @@ </listitem> </varlistentry> <varlistentry> + <term>Show metadata information</term> + <listitem> + <cmdsynopsis> + <command>info</command> + </cmdsynopsis> + <cmdsynopsis> + <command>i</command> + <sbr/> + </cmdsynopsis> + <para>Display metadata information such as the user who last wrote + to the database, the time when the database was last written to, + and the host on which the password database was last written + to.</para> + </listitem> + </varlistentry> + <varlistentry> <term>Write database</term> <listitem> <cmdsynopsis> @@ -423,6 +475,15 @@ <manvolnum>5</manvolnum></citerefentry></para> </listitem> </varlistentry> + <varlistentry> + <term> + <literal>LOGNAME</literal> + </term> + <listitem> + <para>The name of the logged in user which is recorded when writing + the password database</para> + </listitem> + </varlistentry> </variablelist> </refsect1> <refsect1>