1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE
refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd"
[
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
<refentry lang="&language;">
<refentryinfo>
<title>kwallet-query(1)</title>
<author>
<firstname>Valentin</firstname>
<surname>Rusu</surname>
<contrib>Original author</contrib>
<address>
<email>kde@rusu.info</email>
</address>
</author>
<date>2015-06-14</date>
<releaseinfo>Frameworks 5.11</releaseinfo>
<productname>KDE Frameworks</productname>
</refentryinfo>
<refmeta>
<refentrytitle>kwallet-query</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source"> </refmiscinfo>
<refmiscinfo class="manual"> </refmiscinfo>
</refmeta>
<refnamediv>
<refname>kwallet-query</refname>
<refpurpose>&kde; Wallet command-line manipulation tool</refpurpose>
</refnamediv>
<refsynopsisdiv id="_synopsis">
<simpara>
<emphasis role="strong">kwallet-query</emphasis>
<emphasis>OPTIONS</emphasis>
<emphasis>wallet</emphasis>
</simpara>
</refsynopsisdiv>
<refsect1 id="_description">
<title>DESCRIPTION</title>
<simpara><command>kwallet-query</command> comes in handy when shell scripts need to read or update the &kde; Wallet. It works by manipulating the entries displayed in the <emphasis role="strong">&kde; Wallet Manager</emphasis> utility. It’s only parameter is the <emphasis>wallet</emphasis>name the tool should read or update. The operation mode is specified by the options.</simpara>
</refsect1>
<refsect1 id="_options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
<emphasis role="strong">-h,--help</emphasis>
</term>
<listitem>
<simpara>Display a short help message.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">-l,--list-entries</emphasis>
</term>
<listitem>
<simpara>List password entries. These are the folder names displayed in the <emphasis role="strong">&kde; Wallet Manager</emphasis> utility. If the <emphasis role="strong">-f</emphasis> option is given, this will only display the subfolders of the specified folder.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">-r,--read-password</emphasis>
<emphasis>Entry</emphasis>
</term>
<listitem>
<simpara>Read the contents of the given <emphasis>Entry</emphasis> from the <emphasis role="strong">Folder</emphasis>section of the <emphasis>wallet</emphasis> and output it on the standard output. Maps are exported as &JSON; object.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">-w,--write-password</emphasis>
<emphasis>Entry</emphasis>
</term>
<listitem>
<simpara>Write secrets to the given <emphasis>Entry</emphasis> under the <emphasis role="strong">Folder</emphasis> section of the given <emphasis>wallet</emphasis>. The secrets are read from the standard input. Maps take in input a well-formed &JSON; object. <emphasis role="strong">IMPORTANT</emphasis> previous wallet entry value will be overwritten by this option, so be careful when using it!</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">-f,--folder</emphasis>
<emphasis>Folder</emphasis>
</term>
<listitem>
<simpara>Set the <emphasis>wallet</emphasis> folder to <emphasis>Folder</emphasis> value. By default <emphasis role="strong">Passwords</emphasis> is used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">-v,--verbose</emphasis>
</term>
<listitem>
<simpara>Output more information when performing the operation, to
help debugging.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="_exit_status">
<title>EXIT STATUS</title>
<variablelist>
<varlistentry>
<term>
<emphasis role="strong">0</emphasis>
</term>
<listitem>
<simpara>Success.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">1</emphasis>
</term>
<listitem>
<simpara>The wallet
<emphasis>wallet</emphasis> was not found.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">2</emphasis>
</term>
<listitem>
<simpara>The wallet
<emphasis>wallet</emphasis> could not be opened. For example, that
would be an indication of a bad password entry or some other
problem with the &kde; Wallet system.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">3</emphasis>
</term>
<listitem>
<simpara>The <emphasis role="strong">Folder</emphasis> section was not found inside the wallet <emphasis>wallet</emphasis>. Perhaps the wallet file is corrupt?</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="strong">4</emphasis>
</term>
<listitem>
<simpara>The read or write operation has failed for some
reason.</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="_bugs">
<title>BUGS</title>
<simpara>Please report all bugs on the &kde; bug reporting website:
bugs.kde.org. Be sure to select <quote>kwallet-query</quote> when submitting your
bug-report.</simpara>
</refsect1>
<refsect1 id="_author">
<title>AUTHOR</title>
<simpara><command>kwallet-query</command> was originally written by Valentin Rusu and is
part of &kde;.</simpara>
</refsect1>
<refsect1 id="_copying">
<title>COPYING</title>
<simpara>Copyright (C) 2015 Valentin Rusu. Free use of this software is
granted under the terms of the &GNU; General Public License
(GPL).</simpara>
</refsect1>
</refentry>
|
