Mercurial > projects > pwm

annotate pwm.1.xml @ 11:85bce13237cf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add filter expressions to list command Refactor field parsing so it can be used for parsing fields, field assignments and filter expressions.
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Mon, 31 Jul 2017 09:20:21 +0200
parents 17fb30016e64
children 8768fbd09bc5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
1 <?xml version="1.0"?>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
2 <!--
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
3
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
4 Copyright (C) 2017 Guido Berhoerster <guido+pwm@berhoerster.name>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
5
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
6 Permission is hereby granted, free of charge, to any person obtaining
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
7 a copy of this software and associated documentation files (the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
8 "Software"), to deal in the Software without restriction, including
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
9 without limitation the rights to use, copy, modify, merge, publish,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
10 distribute, sublicense, and/or sell copies of the Software, and to
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
11 permit persons to whom the Software is furnished to do so, subject to
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
12 the following conditions:
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
13
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
14 The above copyright notice and this permission notice shall be included
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
15 in all copies or substantial portions of the Software.
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
16
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
24
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
25 -->
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
26 <refentry xmlns="http://docbook.org/ns/docbook"
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
27 xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="en">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
28 <info>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
29 <author>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
30 <personname>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
31 <firstname>Guido</firstname>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
32 <surname>Berhoerster</surname>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
33 </personname>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
34 <email>guido+pwm@berhoerster.name</email>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
35 <personblurb/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
36 </author>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
37 <date>31 July, 2017</date>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
38 </info>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
39 <refmeta>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
40 <refentrytitle>pwm</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
41 <manvolnum>1</manvolnum>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
42 <refmiscinfo class="source"/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
43 <refmiscinfo class="version"/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
44 <refmiscinfo class="manual">User Commands</refmiscinfo>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
45 </refmeta>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
46 <refnamediv>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
47 <refname>pwm</refname>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
48 <refpurpose>password manager</refpurpose>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
49 </refnamediv>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
50 <refsynopsisdiv>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
51 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
52 <command>pwm</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
53 <arg choice="opt">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
54 <option>-P</option>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
55 <replaceable>password_file</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
56 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
57 <arg choice="opt">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
58 <replaceable>database_file</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
59 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
60 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
61 </refsynopsisdiv>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
62 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
63 <title>Description</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
64 <para>The <command>pwm</command> utility is a password manager which
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
65 stores passwords and associated metadata in an encrypted database protected
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
66 by a master password. It offers both a text-based user interface for
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
67 interactive use as well as a non-interactive mode. The database uses the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
68 PasswordSafe database version 3 file format and thus provides
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
69 interoperabity with other password managers using the same format.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
70 <para>After opening an existing database or creating a new one,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
71 <command>pwm</command> provides commands to create, modify, delete, and
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
72 display password database entries which may be organized in groups. The
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
73 contents of a field of a given entry can also be piped to an external
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
74 command, e.g. in order to copy the content of the username or password
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
75 field of an entry to the clipboard.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
76 <para>If specified, <command>pwm</command> will open or create
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
77 <replaceable>database_file</replaceable> instead of the user's default
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
78 database.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
79 <para><command>pwm</command> must be run with a locale which uses the UTF-8
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
80 character encoding.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
81 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
82 <title>Output format</title>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
83 <para>The <command>show</command> and <command>info</command> commands
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
84 display fields by printing the field name followed by a colon, one or
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
85 more space characters and the field's verbatim content to the standard
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
86 output stream. Field content may contain newlines, non-printable and/or
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
87 control characters.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
88 <para>The <command>pipe</command> prints the verbatim field content to the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
89 standard input stream of the given command.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
90 <para>Error messages are printed to the standard error stream.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
91 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
92 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
93 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
94 <title>Options</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
95 <para>The following options are supported:</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
96 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
97 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
98 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
99 <option>-P</option>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
100 <replaceable>password_file</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
101 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
102 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
103 <para>Read the master password from the first line of
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
104 <replaceable>password_file</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
105 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
106 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
107 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
108 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
109 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
110 <title>Usage</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
111 <para>If stdin is connected to a terminal pwm will run in interactive mode
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
112 and prompt the user for the master password unless
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
113 <replaceable>password_file</replaceable> is specified via the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
114 <option>-P</option> option. After successfully opening the password
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
115 database the user will be prompted for a command.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
116 <para>When running in non-interactive mode a file containing the master
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
117 pasword must be specified via the <option>-P</option> option and after
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
118 successfully opening the password database, pwm will execute commands read
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
119 from stdin until either an error occurrs or end-of-file is reached.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
120 <para><command>pwm</command> operates on a copy of the password database
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
121 in memory, any changes must be explicitly written back to the database
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
122 using the write command.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
123 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
124 <title>IDs</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
125 <para>Database entries are referred to by an ID value which is a
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
126 positive integer value that is guaranteed to be unqiue during the run
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
127 time of the pwm utility.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
128 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
129 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
130 <title>Fields</title>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
131 <para>The following entry fields are supported:</para>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
132 <table xml:id="field-table">
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
133 <title>Fields and their identifiers</title>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
134 <tgroup cols="2" align="left" colsep="1" rowsep="1">
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
135 <thead>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
136 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
137 <entry>Field</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
138 <entry>Field Identifier</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
139 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
140 </thead>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
141 <tbody>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
142 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
143 <entry>Group</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
144 <entry>group</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
145 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
146 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
147 <entry>Title</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
148 <entry>title</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
149 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
150 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
151 <entry>Username</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
152 <entry>username</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
153 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
154 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
155 <entry>Password</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
156 <entry>password</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
157 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
158 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
159 <entry>Notes</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
160 <entry>notes</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
161 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
162 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
163 <entry>URL</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
164 <entry>url</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
165 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
166 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
167 <entry>Creation Time</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
168 <entry>ctime</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
169 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
170 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
171 <entry>Modification Time</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
172 <entry>mtime</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
173 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
174 </tbody>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
175 </tgroup>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
176 </table>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
177 <para>Other, existing fields specified by the PasswordSafe file format
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
178 will be preserved but cannot be displayed or modified.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
179 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
180 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
181 <title>Commands</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
182 <para>Each command must appear on a seperate line terminated by a newline
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
183 character. The command and its arguments are seperated by whitespace,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
184 i.e. one or more space or tab characters. If an argument contains
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
185 whitespace characters it must either be quoted by encosing it in single
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
186 or double quote characters or each whitespace character must be preceded
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
187 by a backslash character. Arguments quoted with a single or double quote
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
188 character preserve the literal values of all characters with the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
189 exception of the backslash character which can be used to escape the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
190 respective quoting character. Two consecutive backslash characters yield
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
191 a literal backslash within both quoted and unquoted arguments. A line
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
192 must not end in a single backslash character, any other backslash
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
193 characters are ignored.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
194 <para>If an error occurrs while parsing or executing a command,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
195 <command>pwm</command> will terminate when running in non-interactive
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
196 mode. In interactive mode it will print an error message and prompt the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
197 user for the next command. The following commands are supported:</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
198 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
199 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
200 <term>List entries</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
201 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
202 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
203 <command>list</command>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
204 <arg choice="opt" rep="repeat">
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
205 <replaceable>field</replaceable>~<replaceable>regex</replaceable>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
206 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
207 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
208 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
209 <command>ls</command>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
210 <arg choice="opt" rep="repeat">
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
211 <replaceable>field</replaceable>~<replaceable>regex</replaceable>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
212 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
213 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
214 </cmdsynopsis>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
215 <para>List password database entries. If one or more filter
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
216 expressions are specified, limit the displayed entries to those
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
217 whose <replaceable>field</replaceable> content matches the extended
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
218 regular expression <replaceable>regex</replaceable>.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
219 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
220 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
221 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
222 <term>Create entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
223 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
224 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
225 <command>create</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
226 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
227 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
228 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
229 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
230 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
231 <command>c</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
232 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
233 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
234 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
235 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
236 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
237 <para>Create a new entry assigning each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
238 <replaceable>field</replaceable> to the corresponsing
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
239 <replaceable>value</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
240 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
241 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
242 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
243 <term>Modify entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
244 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
245 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
246 <command>modify</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
247 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
248 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
249 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
250 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
251 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
252 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
253 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
254 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
255 <command>m</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
256 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
257 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
258 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
259 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
260 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
261 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
262 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
263 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
264 <para>Modify an existing entry identified by
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
265 <replaceable>id</replaceable> assigning each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
266 <replaceable>field</replaceable> to the corresponsing
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
267 <replaceable>value</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
268 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
269 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
270 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
271 <term>Remove entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
272 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
273 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
274 <command>remove</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
275 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
276 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
277 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
278 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
279 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
280 <command>rm</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
281 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
282 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
283 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
284 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
285 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
286 <para>Remove an existing entry identified by
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
287 <replaceable>id</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
288 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
289 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
290 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
291 <term>Display entry fields</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
292 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
293 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
294 <command>show</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
295 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
296 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
297 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
298 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
299 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
300 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
301 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
302 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
303 <command>s</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
304 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
305 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
306 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
307 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
308 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
309 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
310 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
311 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
312 <para>Display each <replaceable>field</replaceable> of the entry
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
313 identified by <replaceable>id</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
314 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
315 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
316 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
317 <term>Pipe entry fields to an external command</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
318 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
319 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
320 <command>pipe</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
321 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
322 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
323 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
324 <arg choice="plain" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
325 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
326 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
327 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
328 <replaceable>command</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
329 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
330 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
331 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
332 <command>p</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
333 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
334 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
335 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
336 <arg choice="plain" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
337 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
338 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
339 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
340 <replaceable>command</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
341 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
342 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
343 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
344 <para>Pipe the content of each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
345 <replaceable>field</replaceable> of the entry identified by id to
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
346 command which must be a single argument. The command is executed by
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
347 invoking the <command>sh</command> utility with the <arg>-c</arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
348 option and <replaceable>command</replaceable> as its option
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
349 argument, thus special care should be applied to quoting command.
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
350 See the <citerefentry><refentrytitle>sh</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
351 <manvolnum>1</manvolnum></citerefentry> manual page for
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
352 details.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
353 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
354 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
355 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
356 <term>Create empty group</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
357 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
358 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
359 <command>creategroup</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
360 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
361 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
362 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
363 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
364 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
365 <command>cg</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
366 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
367 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
368 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
369 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
370 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
371 <para>Create a new empty group named
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
372 <replaceable>name</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
373 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
374 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
375 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
376 <term>Remove empty group</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
377 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
378 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
379 <command>removegroup</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
380 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
381 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
382 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
383 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
384 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
385 <command>rg</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
386 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
387 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
388 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
389 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
390 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
391 <para>Remove the empty group named
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
392 <replaceable>name</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
393 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
394 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
395 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
396 <term>Change the master password</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
397 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
398 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
399 <command>changepassword</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
400 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
401 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
402 <command>ch</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
403 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
404 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
405 <para>Change the master password.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
406 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
407 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
408 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
409 <term>Display help text</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
410 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
411 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
412 <command>help</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
413 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
414 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
415 <command>h</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
416 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
417 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
418 <para>Display a list of all commands and a short help text.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
419 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
420 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
421 <varlistentry>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
422 <term>Show metadata information</term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
423 <listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
424 <cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
425 <command>info</command>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
426 </cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
427 <cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
428 <command>i</command>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
429 <sbr/>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
430 </cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
431 <para>Display metadata information such as the user who last wrote
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
432 to the database, the time when the database was last written to,
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
433 and the host on which the password database was last written
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
434 to.</para>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
435 </listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
436 </varlistentry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
437 <varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
438 <term>Write database</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
439 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
440 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
441 <command>write</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
442 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
443 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
444 <command>w</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
445 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
446 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
447 <para>Write all changes back to the password database.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
448 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
449 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
450 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
451 <term>Quit</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
452 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
453 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
454 <command>quit</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
455 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
456 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
457 <command>q</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
458 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
459 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
460 <para>Quit <command>pwm</command>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
461 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
462 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
463 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
464 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
465 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
466 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
467 <title>File Format</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
468 <para>The canonical description of the file format is included with the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
469 distribution of the <citerefentry><refentrytitle>pwsafe</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
470 <manvolnum>1</manvolnum></citerefentry> utility.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
471 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
472 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
473 <title>Environment Variables</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
474 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
475 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
476 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
477 <literal>LANG</literal>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
478 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
479 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
480 <literal>LC_ALL</literal>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
481 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
482 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
483 <para>See <citerefentry><refentrytitle>locale</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
484 <manvolnum>5</manvolnum></citerefentry></para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
485 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
486 </varlistentry>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
487 <varlistentry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
488 <term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
489 <literal>LOGNAME</literal>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
490 </term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
491 <listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
492 <para>The name of the logged in user which is recorded when writing
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
493 the password database</para>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
494 </listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
495 </varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
496 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
497 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
498 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
499 <title>Exit Status</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
500 <para>The following exit values are returned:</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
501 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
502 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
503 <term>0</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
504 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
505 <para>Command successfully executed.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
506 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
507 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
508 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
509 <term>1</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
510 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
511 <para>An unspecified error has occured.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
512 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
513 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
514 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
515 <term>2</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
516 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
517 <para>Invalid command line options were specified.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
518 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
519 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
520 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
521 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
522 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
523 <title>Files</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
524 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
525 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
526 <term><filename>~/.pwm/pwm.psafe3</filename></term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
527 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
528 <para>default password database</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
529 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
530 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
531 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
532 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
533 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
534 <title>See Also</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
535 <para><citerefentry><refentrytitle>pwsafe</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
536 <manvolnum>1</manvolnum></citerefentry>,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
537 <citerefentry><refentrytitle>sh</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
538 <manvolnum>1</manvolnum></citerefentry>,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
539 <citerefentry><refentrytitle>locale</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
540 <manvolnum>5</manvolnum></citerefentry>,
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
541 <citerefentry><refentrytitle>regex</refentrytitle>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
542 <manvolnum>5</manvolnum></citerefentry>,
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
543 <link xlink:href="https://pwsafe.org/"/></para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
544 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
545 </refentry>