Warning, /pim/akonadiclient/doc/man-akonadiclient.1.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ 0003 <!ENTITY % English "INCLUDE"> 0004 ]> 0005 0006 <refentry lang="&language;"> 0007 <refentryinfo> 0008 <title>akonadiclient man page</title> 0009 <author> 0010 <firstname>Bhaskar</firstname> 0011 <surname>Kandiyal</surname> 0012 <contrib>akonadiclient man page.</contrib> 0013 <email>bkandiyal@gmail.com</email></author> 0014 <date>2018-07-26</date> 0015 <productname>AkonadiClient</productname> 0016 </refentryinfo> 0017 0018 <refmeta> 0019 <refentrytitle><command>akonadiclient</command></refentrytitle> 0020 <manvolnum>1</manvolnum> 0021 </refmeta> 0022 0023 <refnamediv> 0024 <refname><command>akonadiclient</command></refname> 0025 <refpurpose>A commandline client for Akonadi</refpurpose> 0026 </refnamediv> 0027 0028 <refsynopsisdiv> 0029 <cmdsynopsis> 0030 <command>akonadiclient</command> 0031 <arg choice="opt">command</arg> 0032 <arg choice="opt">--help</arg> 0033 <arg choice="opt">--version</arg> 0034 <arg choice="opt">&kde; Generic Options</arg> 0035 <arg choice="opt">Qt Generic Options</arg> 0036 </cmdsynopsis> 0037 </refsynopsisdiv> 0038 0039 <refsect1> 0040 <title>Description</title> 0041 <para>akonadiclient is a commandline client for manipulating KDE's Akonadi datastore. It provides an easy way to manipulate Akonadi's data through the commandline. 0042 For example, adding items, collections, renaming or moving collections and also controlling the Akonadi agents.</para> 0043 0044 </refsect1> 0045 0046 <refsect1> 0047 <title>Commands</title> 0048 <refsect2> 0049 <title>Filesystem Commands</title> 0050 <variablelist> 0051 0052 <varlistentry> 0053 <term><option>copy</option></term> 0054 <listitem> 0055 <para>akonadiclient copy [OPTIONS] SOURCE DESTINATION</para> 0056 <para>Used to copy collections or items from one collection to another.</para> 0057 <para>Options:</para> 0058 <variablelist> 0059 <varlistentry> 0060 <term><option>-n, --dryrun</option></term> 0061 <listitem><para>Run without making any actual changes</para></listitem> 0062 </varlistentry> 0063 </variablelist> 0064 </listitem> 0065 </varlistentry> 0066 0067 <varlistentry> 0068 <term><option>create</option></term> 0069 <listitem> 0070 <para>akonadiclient create [OPTIONS] COLLECTION</para> 0071 <para>Creates a new collection. Please note that top-level collections can only be created by an Akonadi resource.</para> 0072 <para>Options:</para> 0073 <variablelist> 0074 <varlistentry> 0075 <term><option>-p, --parent <replaceable>collection</replaceable></option></term> 0076 <listitem><para>Run without making any actual changes</para></listitem> 0077 </varlistentry> 0078 <varlistentry> 0079 <term><option>-n, --dryrun</option></term> 0080 <listitem><para>Run without making any actual changes</para></listitem> 0081 </varlistentry> 0082 </variablelist> 0083 </listitem> 0084 </varlistentry> 0085 0086 <varlistentry> 0087 <term><option>delete</option></term> 0088 <listitem> 0089 <para>akonadiclient delete [OPTIONS] COLLECTION | ITEM</para> 0090 <para>Deletes a collection or an item.</para> 0091 <para>Options:</para> 0092 <variablelist> 0093 <varlistentry> 0094 <term><option>-c, --collection</option></term> 0095 <listitem><para>Assume that a collection is specified as an argument</para></listitem> 0096 </varlistentry> 0097 0098 <varlistentry> 0099 <term><option>-i, --item</option></term> 0100 <listitem><para>Assume that an item is specified as an argument</para></listitem> 0101 </varlistentry> 0102 0103 <varlistentry> 0104 <term><option>-n, --dryrun</option></term> 0105 <listitem><para>Run without making any actual changes</para></listitem> 0106 </varlistentry> 0107 </variablelist> 0108 </listitem> 0109 </varlistentry> 0110 0111 <varlistentry> 0112 <term><option>list</option></term> 0113 <listitem> 0114 <para>akonadiclient list [OPTIONS] COLLECTION</para> 0115 <para>Deletes a collection or an item.</para> 0116 <para>Options:</para> 0117 <variablelist> 0118 0119 <varlistentry> 0120 <term><option>-l, --details</option></term> 0121 <listitem><para>List more detailed information</para></listitem> 0122 </varlistentry> 0123 0124 <varlistentry> 0125 <term><option>-c, --collections</option></term> 0126 <listitem><para>List only sub-collections</para></listitem> 0127 </varlistentry> 0128 0129 <varlistentry> 0130 <term><option>-i, --items</option></term> 0131 <listitem><para>List only contained items</para></listitem> 0132 </varlistentry> 0133 0134 </variablelist> 0135 </listitem> 0136 </varlistentry> 0137 0138 <varlistentry> 0139 <term><option>move</option></term> 0140 <listitem> 0141 <para>akonadiclient move [OPTIONS] SOURCE DESTINATION</para> 0142 <para>Move collections or items into another collection.</para> 0143 <para>Options:</para> 0144 <variablelist> 0145 0146 <varlistentry> 0147 <term><option>-n, --dryrun</option></term> 0148 <listitem><para>Run without making any actual changes</para></listitem> 0149 </varlistentry> 0150 0151 </variablelist> 0152 </listitem> 0153 </varlistentry> 0154 0155 <varlistentry> 0156 <term><option>rename</option></term> 0157 <listitem> 0158 <para>akonadiclient rename [OPTIONS] COLLECTION NAME</para> 0159 <para>Renames a specified collection to NAME</para> 0160 <para>Options:</para> 0161 <variablelist> 0162 0163 <varlistentry> 0164 <term><option>-n, --dryrun</option></term> 0165 <listitem><para>Run without making any actual changes</para></listitem> 0166 </varlistentry> 0167 0168 </variablelist> 0169 </listitem> 0170 </varlistentry> 0171 0172 </variablelist> 0173 </refsect2> 0174 0175 <refsect2> 0176 <title>Data Commands</title> 0177 <variablelist> 0178 0179 <varlistentry> 0180 <term><option>add</option></term> 0181 <listitem> 0182 <para>akonadiclient add [OPTIONS] COLLECTION FILES</para> 0183 <para>Add items to a specified collection</para> 0184 <para>Options:</para> 0185 <variablelist> 0186 0187 <varlistentry> 0188 <term><option>-b, --base <replaceable>dir</replaceable></option></term> 0189 <listitem><para>Base directory for input files / directories, default is current</para></listitem> 0190 </varlistentry> 0191 0192 <varlistentry> 0193 <term><option>-f, --flat</option></term> 0194 <listitem><para>Flat mode, do not duplicate subdirectory structure</para></listitem> 0195 </varlistentry> 0196 0197 <varlistentry> 0198 <term><option>-n, --dryrun</option></term> 0199 <listitem><para>Run without making any actual changes</para></listitem> 0200 </varlistentry> 0201 0202 <varlistentry> 0203 <term><option>-m, --mime <replaceable>mime-type</replaceable></option></term> 0204 <listitem><para>MIME type to use (instead of auto-detection)</para></listitem> 0205 </varlistentry> 0206 0207 </variablelist> 0208 </listitem> 0209 </varlistentry> 0210 0211 <varlistentry> 0212 <term><option>dump</option></term> 0213 <listitem> 0214 <para>akonadiclient dump [OPTIONS] COLLECTION DIRECTORY</para> 0215 <para>Dump a COLLECTION to a DIRECTORY structure</para> 0216 <para>Options:</para> 0217 <variablelist> 0218 0219 <varlistentry> 0220 <term><option>-m, --maildir</option></term> 0221 <listitem><para>Dump email messages in maildir directory structure</para></listitem> 0222 </varlistentry> 0223 0224 <varlistentry> 0225 <term><option>-a, --akonadi-categories</option></term> 0226 <listitem><para>Dump items with Akonadi categories, otherwise text</para></listitem> 0227 </varlistentry> 0228 0229 <varlistentry> 0230 <term><option>-f, --force</option></term> 0231 <listitem><para>Operate even if destination directory is not empty</para></listitem> 0232 </varlistentry> 0233 0234 <varlistentry> 0235 <term><option>-n, --dryrun</option></term> 0236 <listitem><para>Run without making any actual changes</para></listitem> 0237 </varlistentry> 0238 0239 </variablelist> 0240 </listitem> 0241 </varlistentry> 0242 0243 <varlistentry> 0244 <term><option>edit</option></term> 0245 <listitem> 0246 <para>akonadiclient edit [OPTIONS] ITEM</para> 0247 <para>Opens the payload of ITEM in a text editor specified by the environment variable $EDITOR</para> 0248 <para>Options:</para> 0249 <variablelist> 0250 0251 <varlistentry> 0252 <term><option>-n, --dryrun</option></term> 0253 <listitem><para>Run without making any actual changes</para></listitem> 0254 </varlistentry> 0255 0256 </variablelist> 0257 </listitem> 0258 </varlistentry> 0259 0260 <varlistentry> 0261 <term><option>expand</option></term> 0262 <listitem> 0263 <para>akonadiclient expand [OPTIONS] ITEM</para> 0264 <para>Expands a contact group item</para> 0265 <para>Options:</para> 0266 <variablelist> 0267 0268 <varlistentry> 0269 <term><option>-b, --brief</option></term> 0270 <listitem><para>Brief output (email addresses only)</para></listitem> 0271 </varlistentry> 0272 0273 </variablelist> 0274 </listitem> 0275 </varlistentry> 0276 0277 <varlistentry> 0278 <term><option>export</option></term> 0279 <listitem> 0280 <para>akonadiclient export [OPTIONS] COLLECTION FILE</para> 0281 <para>Export the collection specified by COLLECTION to an XML file specified by FILE.</para> 0282 <para>Options:</para> 0283 <variablelist> 0284 0285 <varlistentry> 0286 <term><option>-n, --dryrun</option></term> 0287 <listitem><para>Run without making any actual changes</para></listitem> 0288 </varlistentry> 0289 0290 </variablelist> 0291 </listitem> 0292 </varlistentry> 0293 0294 <varlistentry> 0295 <term><option>group</option></term> 0296 <listitem> 0297 <para>akonadiclient group [OPTIONS] GROUP ARGS</para> 0298 <para>Expand or modify a contact GROUP</para> 0299 <para>Options:</para> 0300 <variablelist> 0301 0302 <varlistentry> 0303 <term><option>-e, --expand</option></term> 0304 <listitem><para>Show the expanded contact group (the default operation)</para></listitem> 0305 </varlistentry> 0306 0307 <varlistentry> 0308 <term><option>-a, --add</option></term> 0309 <listitem><para>Add a contact to the group</para></listitem> 0310 </varlistentry> 0311 0312 <varlistentry> 0313 <term><option>-d, --delete</option></term> 0314 <listitem><para>Delete a contact from the group</para></listitem> 0315 </varlistentry> 0316 0317 <varlistentry> 0318 <term><option>-C, --clean</option></term> 0319 <listitem><para>Remove unknown item references from the group</para></listitem> 0320 </varlistentry> 0321 0322 <varlistentry> 0323 <term><option>-c, --comment <replaceable>name</replaceable></option></term> 0324 <listitem><para>Email comment (name) for an added item</para></listitem> 0325 </varlistentry> 0326 0327 <varlistentry> 0328 <term><option>-b, --brief</option></term> 0329 <listitem><para>Brief output (for 'expand', email addresses only)</para></listitem> 0330 </varlistentry> 0331 0332 <varlistentry> 0333 <term><option>-n, --dryrun</option></term> 0334 <listitem><para>Run without making any actual changes</para></listitem> 0335 </varlistentry> 0336 0337 </variablelist> 0338 </listitem> 0339 </varlistentry> 0340 0341 0342 <varlistentry> 0343 <term><option>import</option></term> 0344 <listitem> 0345 <para>akonadiclient import [OPTIONS] PARENT FILE</para> 0346 <para>Imports an XML file inside the collection specified by PARENT. If the collection already exists, its contents are merged with the contents of the collection in the XML file.</para> 0347 <para>Options:</para> 0348 <variablelist> 0349 0350 <varlistentry> 0351 <term><option>-n, --dryrun</option></term> 0352 <listitem><para>Run without making any actual changes</para></listitem> 0353 </varlistentry> 0354 0355 </variablelist> 0356 </listitem> 0357 </varlistentry> 0358 0359 <varlistentry> 0360 <term><option>info</option></term> 0361 <listitem> 0362 <para>akonadiclient info [OPTIONS] COLLECTION | ITEM</para> 0363 <para>Show full information about a collection or item</para> 0364 <para>Options:</para> 0365 <variablelist> 0366 0367 <varlistentry> 0368 <term><option>-c, --collection</option></term> 0369 <listitem><para>Assume that a collection is specified</para></listitem> 0370 </varlistentry> 0371 0372 <varlistentry> 0373 <term><option>-i, --item</option></term> 0374 <listitem><para>Assume that an item is specified</para></listitem> 0375 </varlistentry> 0376 0377 </variablelist> 0378 </listitem> 0379 </varlistentry> 0380 0381 <varlistentry> 0382 <term><option>show</option></term> 0383 <listitem> 0384 <para>akonadiclient show ITEM</para> 0385 <para>Shows the raw payload of an item</para> 0386 </listitem> 0387 </varlistentry> 0388 0389 <varlistentry> 0390 <term><option>tags</option></term> 0391 <listitem> 0392 <para>akonadiclient tags [OPTIONS]</para> 0393 <para>List all known tags</para> 0394 <para>Options:</para> 0395 <variablelist> 0396 0397 <varlistentry> 0398 <term><option>-b, --brief</option></term> 0399 <listitem><para>Brief output - tag names only</para></listitem> 0400 </varlistentry> 0401 0402 <varlistentry> 0403 <term><option>-u, --urls</option></term> 0404 <listitem><para>Brief output - tag URLs only</para></listitem> 0405 </varlistentry> 0406 0407 </variablelist> 0408 </listitem> 0409 </varlistentry> 0410 0411 <varlistentry> 0412 <term><option>update</option></term> 0413 <listitem> 0414 <para>akonadiclient update [OPTIONS] ITEM FILE</para> 0415 <para>Updates the raw payload of ITEM with the contents of FILE</para> 0416 <para>Options:</para> 0417 <variablelist> 0418 0419 <varlistentry> 0420 <term><option>-n, --dryrun</option></term> 0421 <listitem><para>Run without making any actual changes</para></listitem> 0422 </varlistentry> 0423 0424 </variablelist> 0425 </listitem> 0426 </varlistentry> 0427 0428 </variablelist> 0429 </refsect2> 0430 0431 <refsect2> 0432 <title>Miscellaneous Commands</title> 0433 <variablelist> 0434 0435 <varlistentry> 0436 <term><option>agents</option></term> 0437 <listitem> 0438 <para>akonadiclient agents [OPTIONS] [AGENTS...]</para> 0439 <para>Allows managing of Akonadi agents like changing their state, restarting an agent or listing all agents and their state.</para> 0440 <para>Options:</para> 0441 <variablelist> 0442 0443 <varlistentry> 0444 <term><option>-l, --list</option></term> 0445 <listitem><para>List all agents</para></listitem> 0446 </varlistentry> 0447 0448 <varlistentry> 0449 <term><option>-s, --setstate <replaceable>state</replaceable></option></term> 0450 <listitem><para>Set the state for specified agents. Valid states are 'offline' and 'online'.</para></listitem> 0451 </varlistentry> 0452 0453 <varlistentry> 0454 <term><option>-g, --getstate</option></term> 0455 <listitem><para>Get the state for specified agents</para></listitem> 0456 </varlistentry> 0457 0458 <varlistentry> 0459 <term><option>-i, --info</option></term> 0460 <listitem><para>Show information about the specified agents</para></listitem> 0461 </varlistentry> 0462 0463 <varlistentry> 0464 <term><option>-r, --restart</option></term> 0465 <listitem><para>Restarts the specified agents</para></listitem> 0466 </varlistentry> 0467 0468 <varlistentry> 0469 <term><option>-n, --dryrun</option></term> 0470 <listitem><para>Run without making any actual changes</para></listitem> 0471 </varlistentry> 0472 0473 </variablelist> 0474 </listitem> 0475 </varlistentry> 0476 0477 <varlistentry> 0478 <term><option>help</option></term> 0479 <listitem> 0480 <para>akonadiclient help [COMMAND]</para> 0481 <para>Displays help for COMMAND. If COMMAND is not specified then it lists all the available commands</para> 0482 </listitem> 0483 </varlistentry> 0484 0485 <varlistentry> 0486 <term><option>shell</option></term> 0487 <listitem> 0488 <para>akonadiclient shell</para> 0489 <para>Enter commands in an interactive shell</para> 0490 </listitem> 0491 </varlistentry> 0492 </variablelist> 0493 </refsect2> 0494 </refsect1> 0495 0496 <refsect1> 0497 <title>Examples</title> 0498 <para><emphasis role="bold">akonadiclient list /</emphasis> - Lists all the collections under the root collection</para> 0499 <para><emphasis role="bold">akonadiclient export /Notes notes.xml</emphasis> - Exports all the items and sub-collections of the /Notes collection to the file 'notes.xml'</para> 0500 <para><emphasis role="bold">akonadiclient agents -l</emphasis> - Lists all agents</para> 0501 <para><emphasis role="bold">akonadiclient add /Notes note.txt</emphasis> - Adds the contents of the file note.txt as an item in the collection /Notes</para> 0502 <para><emphasis role="bold">akonadiclient add -m application/x-vnd.akonadi.calendar.todo /Todos todo.ics</emphasis> - Adds the contents of the file todo.ics as a TODO calendar entry in the collection /Todos</para> 0503 </refsect1> 0504 0505 </refentry>