Mercurial > projects > pwm

annotate pwm.1.xml @ 25:616385fa1fd9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Build common functions as a library that can be reused
author Guido Berhoerster <guido+pwm@berhoerster.name>
date Wed, 20 Sep 2017 23:57:51 +0200
parents 1b89066d992c
children 5bdea77d0c1d
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>
23
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
37 <date>17 September, 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">
23
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
58 <option>-R</option>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
59 </arg>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
60 <arg choice="opt">
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
61 <replaceable>database_file</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
62 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
63 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
64 </refsynopsisdiv>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
65 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
66 <title>Description</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
67 <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
68 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
69 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
70 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
71 PasswordSafe database version 3 file format and thus provides
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
72 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
73 <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
74 <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
75 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
76 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
77 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
78 field of an entry to the clipboard.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
79 <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
80 <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
81 database.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
82 <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
83 character encoding.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
84 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
85 <title>Output format</title>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
86 <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
87 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
88 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
89 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
90 control characters.</para>
17
a08ef0674d8e Page long output in interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 16
diff changeset
91 <para>If running in interactive mode, the <command>list</command>,
a08ef0674d8e Page long output in interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 16
diff changeset
92 <command>show</command> and <command>info</command> will display
a08ef0674d8e Page long output in interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 16
diff changeset
93 the results on a page-by-page basis using an internal pager.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
94 <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
95 standard input stream of the given command.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
96 <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
97 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
98 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
99 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
100 <title>Options</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
101 <para>The following options are supported:</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
102 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
103 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
104 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
105 <option>-P</option>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
106 <replaceable>password_file</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
107 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
108 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
109 <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
110 <replaceable>password_file</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
111 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
112 </varlistentry>
23
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
113 <varlistentry>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
114 <term>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
115 <option>-R</option>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
116 </term>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
117 <listitem>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
118 <para>Treat the database as read-only and disallow any modifications
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
119 and write operations.</para>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
120 </listitem>
1b89066d992c Add read-only mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 22
diff changeset
121 </varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
122 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
123 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
124 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
125 <title>Usage</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
126 <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
127 and prompt the user for the master password unless
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
128 <replaceable>password_file</replaceable> is specified via the
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
129 <option>-P</option> option. After successfully opening the password
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
130 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
131 <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
132 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
133 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
134 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
135 <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
136 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
137 using the write command.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
138 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
139 <title>IDs</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
140 <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
141 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
142 time of the pwm utility.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
143 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
144 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
145 <title>Fields</title>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
146 <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
147 <table xml:id="field-table">
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
148 <title>Fields and their identifiers</title>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
149 <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
150 <thead>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
151 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
152 <entry>Field</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
153 <entry>Field Identifier</entry>
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 </thead>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
156 <tbody>
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 <entry>Group</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
159 <entry>group</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
160 </row>
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 <entry>Title</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
163 <entry>title</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
164 </row>
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 <entry>Username</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
167 <entry>username</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
168 </row>
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 <entry>Password</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
171 <entry>password</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
172 </row>
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 <entry>Notes</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
175 <entry>notes</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
176 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
177 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
178 <entry>URL</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
179 <entry>url</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
180 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
181 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
182 <entry>Creation Time</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
183 <entry>ctime</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
184 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
185 <row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
186 <entry>Modification Time</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
187 <entry>mtime</entry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
188 </row>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
189 </tbody>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
190 </tgroup>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
191 </table>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
192 <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
193 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
194 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
195 <refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
196 <title>Commands</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
197 <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
198 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
199 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
200 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
201 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
202 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
203 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
204 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
205 respective quoting character. Two consecutive backslash characters yield
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
206 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
207 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
208 characters are ignored.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
209 <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
210 <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
211 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
212 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
213 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
214 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
215 <term>List entries</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
216 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
217 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
218 <command>list</command>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
219 <arg choice="opt" rep="repeat">
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
220 <replaceable>field</replaceable>~<replaceable>regex</replaceable>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
221 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
222 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
223 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
224 <command>ls</command>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
225 <arg choice="opt" rep="repeat">
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
226 <replaceable>field</replaceable>~<replaceable>regex</replaceable>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
227 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
228 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
229 </cmdsynopsis>
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
230 <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
231 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
232 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
233 regular expression <replaceable>regex</replaceable>.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
234 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
235 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
236 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
237 <term>Create entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
238 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
239 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
240 <command>create</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
241 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
242 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
243 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
244 </cmdsynopsis>
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>c</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
247 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
248 <replaceable>field</replaceable>=<replaceable>value</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 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
251 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
252 <para>Create a new entry assigning each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
253 <replaceable>field</replaceable> to the corresponsing
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
254 <replaceable>value</replaceable>.</para>
22
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
255 <para>If no fields are specified in interactive mode,
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
256 <command>pwm</command> will prompt the user for the content of
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
257 each field.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
258 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
259 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
260 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
261 <term>Modify entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
262 <listitem>
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 <command>modify</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
265 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
266 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
267 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
268 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
269 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
270 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
271 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
272 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
273 <command>m</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
274 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
275 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
276 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
277 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
278 <replaceable>field</replaceable>=<replaceable>value</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
279 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
280 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
281 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
282 <para>Modify an existing entry identified by
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
283 <replaceable>id</replaceable> assigning each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
284 <replaceable>field</replaceable> to the corresponsing
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
285 <replaceable>value</replaceable>.</para>
22
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
286 <para>If no fields are specified and <command>pwm</command> is
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
287 running in interactive mode, it will prompt the user for the
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
288 content of each field, allowing him to edit any previous
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
289 content.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
290 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
291 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
292 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
293 <term>Remove entry</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
294 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
295 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
296 <command>remove</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
297 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
298 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
299 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
300 </cmdsynopsis>
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 <command>rm</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
303 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
304 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
305 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
306 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
307 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
308 <para>Remove an existing entry identified by
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
309 <replaceable>id</replaceable>.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
310 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
311 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
312 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
313 <term>Display entry fields</term>
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 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
316 <command>show</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
317 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
318 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
319 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
320 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
321 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
322 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
323 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
324 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
325 <command>s</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
326 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
327 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
328 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
329 <arg choice="opt" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
330 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
331 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
332 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
333 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
334 <para>Display each <replaceable>field</replaceable> of the entry
15
3380c8fd9776 Show all record fields except the password by default
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 14
diff changeset
335 identified by <replaceable>id</replaceable>. If no field is
3380c8fd9776 Show all record fields except the password by default
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 14
diff changeset
336 specified, display all fields except the password field.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
337 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
338 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
339 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
340 <term>Pipe entry fields to an external command</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
341 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
342 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
343 <command>pipe</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
344 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
345 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
346 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
347 <arg choice="plain" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
348 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
349 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
350 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
351 <replaceable>command</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
352 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
353 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
354 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
355 <command>p</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
356 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
357 <replaceable>id</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
358 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
359 <arg choice="plain" rep="repeat">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
360 <replaceable>field</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
361 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
362 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
363 <replaceable>command</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
364 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
365 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
366 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
367 <para>Pipe the content of each given
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
368 <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
369 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
370 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
371 option and <replaceable>command</replaceable> as its option
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
372 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
373 See the <citerefentry><refentrytitle>sh</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
374 <manvolnum>1</manvolnum></citerefentry> manual page for
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
375 details.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
376 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
377 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
378 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
379 <term>Create empty group</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
380 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
381 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
382 <command>creategroup</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
383 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
384 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
385 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
386 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
387 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
388 <command>cg</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
389 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
390 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
391 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
392 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
393 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
394 <para>Create a new empty group named
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
395 <replaceable>name</replaceable>.</para>
22
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
396 <para>In interactive-mode the <replaceable>name</replaceable>
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
397 argument is optional, if it is not specified <command>pwm</command>
ec01c579024a Add fully interactive mode
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 21
diff changeset
398 will prompt the user for it.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
399 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
400 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
401 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
402 <term>Remove empty group</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
403 <listitem>
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 <command>removegroup</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
406 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
407 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
408 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
409 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
410 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
411 <command>rg</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
412 <arg choice="plain">
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
413 <replaceable>name</replaceable>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
414 </arg>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
415 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
416 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
417 <para>Remove the empty group named
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
418 <replaceable>name</replaceable>.</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>
12
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
422 <term>Generate a random password</term>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
423 <listitem>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
424 <cmdsynopsis>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
425 <command>generatepassword</command>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
426 <arg choice="opt">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
427 <replaceable>id</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
428 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
429 <arg choice="opt">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
430 len=<replaceable>n</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
431 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
432 <arg choice="opt" rep="repeat">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
433 chars=<replaceable>n</replaceable>:<replaceable>chars</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
434 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
435 <arg choice="opt" rep="repeat">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
436 charclass=<replaceable>n</replaceable>:<replaceable>class</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
437 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
438 </cmdsynopsis>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
439 <cmdsynopsis>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
440 <command>gp</command>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
441 <arg choice="opt">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
442 <replaceable>id</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
443 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
444 <arg choice="opt">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
445 len=<replaceable>n</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
446 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
447 <arg choice="opt" rep="repeat">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
448 chars=<replaceable>n</replaceable>:<replaceable>chars</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
449 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
450 <arg choice="opt" rep="repeat">
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
451 charclass=<replaceable>n</replaceable>:<replaceable>class</replaceable>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
452 </arg>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
453 <sbr/>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
454 </cmdsynopsis>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
455 <para>Randomly generate a new password according to the specified
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
456 constraints. The <literal>len</literal> argument sets the length of
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
457 the generated password to <replaceable>n</replaceable> characters.
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
458 The <literal>chars</literal> argument constrains the password to
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
459 <replaceable>n</replaceable> from the set of characters
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
460 <replaceable>chars</replaceable>. Similarly, the
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
461 <literal>charclass</literal> argument to
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
462 <replaceable>n</replaceable> characters from the extended regular
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
463 expression character class <replaceable>class</replaceable>.
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
464 Multiple <literal>char</literal> and <literal>charclass</literal>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
465 arguments may be specified, in which case the generated passwords
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
466 match all of them.</para>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
467 </listitem>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
468 </varlistentry>
8768fbd09bc5 Add generatepassword command to generate random passwords
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 11
diff changeset
469 <varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
470 <term>Change the master password</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
471 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
472 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
473 <command>changepassword</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
474 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
475 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
476 <command>ch</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
477 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
478 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
479 <para>Change the master password.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
480 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
481 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
482 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
483 <term>Display help text</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
484 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
485 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
486 <command>help</command>
14
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
487 <arg choice="opt">
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
488 <replaceable>command</replaceable>
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
489 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
490 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
491 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
492 <command>h</command>
14
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
493 <arg choice="opt">
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
494 <replaceable>command</replaceable>
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
495 </arg>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
496 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
497 </cmdsynopsis>
14
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
498 <para>Display a summary of all commands or usage information for
a01899a6e4bb Extend help command to show usage information for commands
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 13
diff changeset
499 the specified <replaceable>command</replaceable>.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
500 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
501 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
502 <varlistentry>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
503 <term>Show metadata information</term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
504 <listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
505 <cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
506 <command>info</command>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
507 </cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
508 <cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
509 <command>i</command>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
510 <sbr/>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
511 </cmdsynopsis>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
512 <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
513 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
514 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
515 to.</para>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
516 </listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
517 </varlistentry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
518 <varlistentry>
16
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
519 <term>Display status messages</term>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
520 <listitem>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
521 <cmdsynopsis>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
522 <command>status</command>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
523 </cmdsynopsis>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
524 <cmdsynopsis>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
525 <command>t</command>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
526 <sbr/>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
527 </cmdsynopsis>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
528 <para>Redisplay any error message from the previous command and
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
529 whether there are unsaved changes.</para>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
530 </listitem>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
531 </varlistentry>
a07665727c19 Add status command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 15
diff changeset
532 <varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
533 <term>Write database</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
534 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
535 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
536 <command>write</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
537 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
538 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
539 <command>w</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
540 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
541 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
542 <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
543 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
544 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
545 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
546 <term>Quit</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
547 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
548 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
549 <command>quit</command>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
550 </cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
551 <cmdsynopsis>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
552 <command>q</command>
21
ee4d36c85287 Make EOF in interactive mode equivalent to the q command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 20
diff changeset
553 </cmdsynopsis>
ee4d36c85287 Make EOF in interactive mode equivalent to the q command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 20
diff changeset
554 <cmdsynopsis>
ee4d36c85287 Make EOF in interactive mode equivalent to the q command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 20
diff changeset
555 <keysym>end-of-file</keysym>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
556 <sbr/>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
557 </cmdsynopsis>
13
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
558 <para>Quit <command>pwm</command>. If running in interactive mode
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
559 and there are unsaved changes, <command>pwm</command> will not
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
560 terminate but display a warning message. If the quit command is
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
561 invoked twice consecutively, <command>pwm</command> will discard
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
562 unsaved changes and terminate.</para>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
563 </listitem>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
564 </varlistentry>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
565 <varlistentry>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
566 <term>Quit and discard unsaved changes</term>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
567 <listitem>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
568 <cmdsynopsis>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
569 <command>Quit</command>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
570 </cmdsynopsis>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
571 <cmdsynopsis>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
572 <command>Q</command>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
573 <sbr/>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
574 </cmdsynopsis>
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
575 <para>Quit <command>pwm</command> and discard any unsaved changes
cf81eb0c2d5a Warn before quitting if there are unsaved changes
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 12
diff changeset
576 without a warning.</para>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
577 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
578 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
579 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
580 </refsect2>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
581 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
582 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
583 <title>File Format</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
584 <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
585 distribution of the <citerefentry><refentrytitle>pwsafe</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
586 <manvolnum>1</manvolnum></citerefentry> utility.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
587 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
588 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
589 <title>Environment Variables</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
590 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
591 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
592 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
593 <literal>LANG</literal>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
594 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
595 <term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
596 <literal>LC_ALL</literal>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
597 </term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
598 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
599 <para>See <citerefentry><refentrytitle>locale</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
600 <manvolnum>5</manvolnum></citerefentry></para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
601 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
602 </varlistentry>
10
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
603 <varlistentry>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
604 <term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
605 <literal>LOGNAME</literal>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
606 </term>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
607 <listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
608 <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
609 the password database</para>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
610 </listitem>
17fb30016e64 Enable access to record and file metadata
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 1
diff changeset
611 </varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
612 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
613 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
614 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
615 <title>Exit Status</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
616 <para>The following exit values are returned:</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
617 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
618 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
619 <term>0</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
620 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
621 <para>Command successfully executed.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
622 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
623 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
624 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
625 <term>1</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
626 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
627 <para>An unspecified error has occured.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
628 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
629 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
630 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
631 <term>2</term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
632 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
633 <para>Invalid command line options were specified.</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
634 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
635 </varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
636 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
637 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
638 <refsect1>
20
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
639 <title>Asynchronous Events</title>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
640 <variablelist>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
641 <varlistentry>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
642 <term><literal>SIGINT</literal></term>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
643 <term><literal>SIGHUP</literal></term>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
644 <term><literal>SIGTERM</literal></term>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
645 <listitem>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
646 <para>If there are changes since the database was last written and
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
647 <command>pwm</command> is running in interactive mode, it
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
648 automatically writes a copy of the current database to the file
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
649 <filename>~/.pwm/autosave.psafe3</filename> which may be used for
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
650 recovery later.</para>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
651 </listitem>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
652 </varlistentry>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
653 </variablelist>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
654 </refsect1>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
655 <refsect1>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
656 <title>Files</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
657 <variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
658 <varlistentry>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
659 <term><filename>~/.pwm/pwm.psafe3</filename></term>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
660 <listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
661 <para>default password database</para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
662 </listitem>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
663 </varlistentry>
20
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
664 <varlistentry>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
665 <term><filename>~/.pwm/autosave.psafe3</filename></term>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
666 <listitem>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
667 <para>automatic copy of the password database after receiving a fatal
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
668 signal in interactive mode</para>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
669 </listitem>
efef93e54c5f Automatically save the database when receiving a fatal signal
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 17
diff changeset
670 </varlistentry>
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
671 </variablelist>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
672 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
673 <refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
674 <title>See Also</title>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
675 <para><citerefentry><refentrytitle>pwsafe</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
676 <manvolnum>1</manvolnum></citerefentry>,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
677 <citerefentry><refentrytitle>sh</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
678 <manvolnum>1</manvolnum></citerefentry>,
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
679 <citerefentry><refentrytitle>locale</refentrytitle>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
680 <manvolnum>5</manvolnum></citerefentry>,
11
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
681 <citerefentry><refentrytitle>regex</refentrytitle>
85bce13237cf Add filter expressions to list command
Guido Berhoerster <guido+pwm@berhoerster.name>
parents: 10
diff changeset
682 <manvolnum>5</manvolnum></citerefentry>,
1
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
683 <link xlink:href="https://pwsafe.org/"/></para>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
684 </refsect1>
55281f14dc9b Add README file and manpage
Guido Berhoerster <guido+pwm@berhoerster.name>
parents:
diff changeset
685 </refentry>