Warning, /frameworks/kwallet/docs/kwallet-query/man-kwallet-query.1.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="utf-8"?> 0002 <!DOCTYPE 0003 refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" 0004 "dtd/kdedbx45.dtd" 0005 [ 0006 <!ENTITY % English "INCLUDE"><!-- change language only here --> 0007 ]> 0008 <refentry lang="&language;"> 0009 <refentryinfo> 0010 <title>kwallet-query(1)</title> 0011 <author> 0012 <firstname>Valentin</firstname> 0013 <surname>Rusu</surname> 0014 <contrib>Original author</contrib> 0015 <address> 0016 <email>kde@rusu.info</email> 0017 </address> 0018 </author> 0019 <date>2015-06-14</date> 0020 <releaseinfo>Frameworks 5.11</releaseinfo> 0021 <productname>KDE Frameworks</productname> 0022 </refentryinfo> 0023 <refmeta> 0024 <refentrytitle>kwallet-query</refentrytitle> 0025 <manvolnum>1</manvolnum> 0026 <refmiscinfo class="source"> </refmiscinfo> 0027 <refmiscinfo class="manual"> </refmiscinfo> 0028 </refmeta> 0029 <refnamediv> 0030 <refname>kwallet-query</refname> 0031 <refpurpose>&kde; Wallet command-line manipulation tool</refpurpose> 0032 </refnamediv> 0033 <refsynopsisdiv id="_synopsis"> 0034 <simpara> 0035 <emphasis role="strong">kwallet-query</emphasis> 0036 <emphasis>OPTIONS</emphasis> 0037 <emphasis>wallet</emphasis> 0038 </simpara> 0039 </refsynopsisdiv> 0040 <refsect1 id="_description"> 0041 <title>DESCRIPTION</title> 0042 <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> 0043 </refsect1> 0044 <refsect1 id="_options"> 0045 <title>OPTIONS</title> 0046 <variablelist> 0047 <varlistentry> 0048 <term> 0049 <emphasis role="strong">-h,--help</emphasis> 0050 </term> 0051 <listitem> 0052 <simpara>Display a short help message.</simpara> 0053 </listitem> 0054 </varlistentry> 0055 <varlistentry> 0056 <term> 0057 <emphasis role="strong">-l,--list-entries</emphasis> 0058 </term> 0059 <listitem> 0060 <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> 0061 </listitem> 0062 </varlistentry> 0063 <varlistentry> 0064 <term> 0065 <emphasis role="strong">-r,--read-password</emphasis> 0066 <emphasis>Entry</emphasis> 0067 </term> 0068 <listitem> 0069 <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> 0070 </listitem> 0071 </varlistentry> 0072 <varlistentry> 0073 <term> 0074 <emphasis role="strong">-w,--write-password</emphasis> 0075 <emphasis>Entry</emphasis> 0076 </term> 0077 <listitem> 0078 <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> 0079 </listitem> 0080 </varlistentry> 0081 <varlistentry> 0082 <term> 0083 <emphasis role="strong">-f,--folder</emphasis> 0084 <emphasis>Folder</emphasis> 0085 </term> 0086 <listitem> 0087 <simpara>Set the <emphasis>wallet</emphasis> folder to <emphasis>Folder</emphasis> value. By default <emphasis role="strong">Passwords</emphasis> is used.</simpara> 0088 </listitem> 0089 </varlistentry> 0090 <varlistentry> 0091 <term> 0092 <emphasis role="strong">-v,--verbose</emphasis> 0093 </term> 0094 <listitem> 0095 <simpara>Output more information when performing the operation, to 0096 help debugging.</simpara> 0097 </listitem> 0098 </varlistentry> 0099 </variablelist> 0100 </refsect1> 0101 <refsect1 id="_exit_status"> 0102 <title>EXIT STATUS</title> 0103 <variablelist> 0104 <varlistentry> 0105 <term> 0106 <emphasis role="strong">0</emphasis> 0107 </term> 0108 <listitem> 0109 <simpara>Success.</simpara> 0110 </listitem> 0111 </varlistentry> 0112 <varlistentry> 0113 <term> 0114 <emphasis role="strong">1</emphasis> 0115 </term> 0116 <listitem> 0117 <simpara>The wallet 0118 <emphasis>wallet</emphasis> was not found.</simpara> 0119 </listitem> 0120 </varlistentry> 0121 <varlistentry> 0122 <term> 0123 <emphasis role="strong">2</emphasis> 0124 </term> 0125 <listitem> 0126 <simpara>The wallet 0127 <emphasis>wallet</emphasis> could not be opened. For example, that 0128 would be an indication of a bad password entry or some other 0129 problem with the &kde; Wallet system.</simpara> 0130 </listitem> 0131 </varlistentry> 0132 <varlistentry> 0133 <term> 0134 <emphasis role="strong">3</emphasis> 0135 </term> 0136 <listitem> 0137 <simpara>The <emphasis role="strong">Folder</emphasis> section was not found inside the wallet <emphasis>wallet</emphasis>. Perhaps the wallet file is corrupt?</simpara> 0138 </listitem> 0139 </varlistentry> 0140 <varlistentry> 0141 <term> 0142 <emphasis role="strong">4</emphasis> 0143 </term> 0144 <listitem> 0145 <simpara>The read or write operation has failed for some 0146 reason.</simpara> 0147 </listitem> 0148 </varlistentry> 0149 </variablelist> 0150 </refsect1> 0151 <refsect1 id="_bugs"> 0152 <title>BUGS</title> 0153 <simpara>Please report all bugs on the &kde; bug reporting website: 0154 bugs.kde.org. Be sure to select <quote>kwallet-query</quote> when submitting your 0155 bug-report.</simpara> 0156 </refsect1> 0157 <refsect1 id="_author"> 0158 <title>AUTHOR</title> 0159 <simpara><command>kwallet-query</command> was originally written by Valentin Rusu and is 0160 part of &kde;.</simpara> 0161 </refsect1> 0162 <refsect1 id="_copying"> 0163 <title>COPYING</title> 0164 <simpara>Copyright (C) 2015 Valentin Rusu. Free use of this software is 0165 granted under the terms of the &GNU; General Public License 0166 (GPL).</simpara> 0167 </refsect1> 0168 </refentry> 0169