doc/konsolekalendar/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4
   5   <!ENTITY konsolekalendar "<application>KonsoleKalendar</application>">
   6   <!ENTITY kappname "KonsoleKalendar">
   7   <!ENTITY package "kdepim">
   8   <!ENTITY % addindex "IGNORE">
   9   <!ENTITY % English "INCLUDE">
  10 ]>
  11 <!-- The language must NOT be changed here. -->
  12
  13 <book lang="&language;">
  14
  15 <bookinfo>
  16
  17 <title>The &konsolekalendar; Handbook</title>
  18
  19 <authorgroup>
  20 <author>
  21 <firstname>Tuukka</firstname>
  22 <surname>Pasanen</surname>
  23 <affiliation><address><email>illuusio@mailcity.com</email></address></affiliation>
  24 </author>
  25
  26 <author>
  27 <firstname>Allen</firstname>
  28 <surname>Winter</surname>
  29 <affiliation><address><email>winterz@kde.org</email></address></affiliation>
  30 </author>
  31
  32 <othercredit role="reviewer">
  33 <firstname>Malcolm</firstname>
  34 <surname>Hunter</surname>
  35 <affiliation><address><email>malcolm.hunter@gmx.co.uk</email></address></affiliation>
  36 <contrib>Reviewer</contrib>
  37 </othercredit>
  38 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  39 </authorgroup>
  40
  41 <copyright>
  42 <year>2002</year><year>2004</year><holder>Tuukka Pasanen</holder>
  43 </copyright>
  44
  45 <copyright>
  46 <year>2003</year><year>2007</year><holder>Allen Winter</holder>
  47 </copyright>
  48
  49 <legalnotice>&FDLNotice;</legalnotice>
  50
  51 <!-- Don't change format of date and version of the documentation -->
  52
  53 <date>2004-04-15</date>
  54 <releaseinfo>1.1.1</releaseinfo>
  55
  56 <abstract>
  57 <para>&konsolekalendar; is a command line interface to &kde; calendars.</para>
  58 </abstract>
  59
  60
  61 <keywordset>
  62 <keyword>KDE</keyword>
  63 <keyword>&package;</keyword>
  64 <keyword>&kappname;</keyword>
  65 <keyword>KOrganizer</keyword>
  66 </keywordset>
  67
  68 </bookinfo>
  69
  70 <chapter id="introduction">
  71 <title>Introduction</title>
  72
  73 <para>&konsolekalendar; is a command line interface to &kde; calendars.
  74 It lets you view, insert, remove, or modify calendar events by way of
  75 the command line or from a scripting language.
  76 Additionally, &konsolekalendar; can create a new &kde; calendar,
  77 export a &kde; calendar to a variety of other formats, and
  78 import another &kde; calendar.</para>
  79
  80 <para>In its basic mode, &konsolekalendar; displays the list of
  81 events in your default calendar for the current day (from 7:00 to 17:00).</para>
  82
  83 <para>Main features of &konsolekalendar;:
  84 <itemizedlist>
  85 <listitem><para>View calendar entries from a start date/time to end date/time</para></listitem>
  86 <listitem><para>Insert (add) calendar entries</para></listitem>
  87 <listitem><para>Remove (delete) calendar entries</para></listitem>
  88 <listitem><para>Modify (change) calendar entries</para></listitem>
  89 <listitem><para>Create a new calendar</para></listitem>
  90 <listitem><para>Export calendar entries to other file formats</para></listitem>
  91 <listitem><para>Import an existing &kde; calendar</para></listitem>
  92 </itemizedlist></para>
  93
  94 <para>&konsolekalendar; is <emphasis>not</emphasis> another graphical
  95 user interface to a &kde; calendar (i.e. &korganizer;).  &konsolekalendar;
  96 is intended solely for uses where a graphical user interface is
  97 not practical or possible.</para>
  98
  99 <para>&konsolekalendar; does <emphasis>not</emphasis> provide a full-featured
 100 language for making queries of the user's calendar: nor is it the intention
 101 of the authors to ever write such a capability.  Primitive command line
 102 options are provided for accessing calendar events within a consecutive
 103 range of dates/time stamps.
 104 </para>
 105
 106 </chapter>
 107
 108 <chapter id="features">
 109 <title>Features</title>
 110 <para>In this chapter you'll learn about the main features of
 111 &konsolekalendar; and how to control them using the command line parameters
 112 (remember that &konsolekalendar; is not a graphical user interface;
 113 it is a command line program only).</para>
 114
 115 <para>
 116 You'll learn about inserting, deleting, and changing
 117 calendar events, and how to export events to other file formats.
 118 The creation and importation of &kde; calendars will also be covered
 119 in this chapter.
 120 </para>
 121
 122 <sect1 id="viewing">
 123 <title>Viewing Events</title>
 124
 125 <para>In its default mode, or by using the <parameter>--view</parameter>
 126 option, &konsolekalendar; will list all events within the range of a specified
 127 date/time.</para>
 128
 129 <para>
 130 <informalexample><para>To view all of today's events (from 7:00 to 17:00), simply run:</para>
 131
 132 <para>
 133 <screen>
 134 <prompt>%</prompt><userinput> <command>konsolekalendar</command>
 135 </userinput>
 136 </screen>
 137 </para>
 138 </informalexample>
 139 </para>
 140
 141 <para>
 142 <informalexample><para>In this next example, we view all events for the week of August 18-22:</para>
 143
 144 <para>
 145 <screen>
 146 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--view</option> <option>--date <replaceable>2003-08-18</replaceable> </option> <option>--end-date <replaceable>2003-08-22</replaceable></option>
 147 </userinput>
 148 </screen>
 149 </para>
 150 </informalexample>
 151 </para>
 152
 153 <para>
 154 <informalexample><para>Show the next event(s) on the calendar from the current time forward:</para>
 155
 156 <para>
 157 <screen>
 158 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--next</option>
 159 </userinput>
 160 </screen>
 161 </para>
 162 </informalexample>
 163 </para>
 164
 165 <para>
 166 <informalexample><para>To view all events for the next 5 days run:</para>
 167
 168 <para>
 169 <screen>
 170 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--show-next</option> <replaceable>5</replaceable>
 171
 172 </userinput>
 173 </screen>
 174 </para>
 175 </informalexample>
 176 </para>
 177
 178 </sect1>
 179
 180 <sect1 id="inserting">
 181 <title>Inserting Events</title>
 182
 183 <para>&konsolekalendar; can insert events into a &kde; calendar or calendar
 184 resource using the <parameter>--add</parameter> command line argument.
 185 Events successfully inserted will be immediately shown by &kde; calendar
 186 applications (like &korganizer;).</para>
 187
 188 <para>
 189 <informalexample><para>In the following example, an event starting on 2003-06-04 (June 4, 2003)
 190 at 1000 and ending at 1200 with summary "Doctor Visit" will be
 191 inserted into the user's default calendar resource:</para>
 192
 193
 194 <para>
 195 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--date <replaceable>2003-06-04</replaceable></option> <option>--time <replaceable>10:00</replaceable></option> \
 196 <option>--end-time <replaceable>12:00</replaceable></option> <option>--summary <replaceable>"Doctor Visit"</replaceable></option></userinput></screen>
 197 </para>
 198 </informalexample>
 199 </para>
 200
 201 <para>
 202 <informalexample><para>In this example, a birthday event is added into the
 203 user's default calendar resource:</para>
 204
 205 <para>
 206 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--date <replaceable>2003-06-06</replaceable></option> <option>--summary <replaceable>"My Birthday"</replaceable></option> \
 207 <option>--description <replaceable>"Party Time"</replaceable></option></userinput></screen>
 208 </para>
 209 </informalexample>
 210 </para>
 211
 212 <para>
 213 <informalexample><para> Here a one week vacation is inserted into a shared <replaceable>vacation</replaceable> calendar:</para>
 214
 215 <para>
 216 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--file <replaceable>vacation.ics</replaceable></option> <option>--date <replaceable>2003-08-01</replaceable></option> \
 217 <option>--end-date <replaceable>2003-08-07</replaceable></option> <option>--summary <replaceable>"Vacation"</replaceable></option> <option>--description <replaceable>"Nobody will ever find me!"</replaceable></option></userinput></screen>
 218 </para>
 219 </informalexample>
 220 </para>
 221
 222 </sect1>
 223
 224 <sect1 id="deleting">
 225 <title>Removing Entries</title>
 226
 227 <para>&konsolekalendar; supports the removal of entries in a calendar file or
 228 resource using the <parameter>--delete</parameter> command line argument.
 229 Calendar entries to be removed are specified exactly by their Unique-string
 230 identifier (<acronym>UID</acronym>) using the <parameter>--uid</parameter>
 231 option.  <acronym>UIDs</acronym> are found by first viewing the event,
 232 using the <parameter>--view</parameter> option.</para>
 233
 234 <para>Events successfully deleted will be immediately removed from within &kde; calendar
 235 applications (&korganizer; for example).</para>
 236
 237 <warning><para> When you delete something from the calendar you
 238 <emphasis>cannot</emphasis> undo it! In other words, when you delete an entry
 239 you cannot reverse the deletion. It's gone for good.</para></warning>
 240
 241 <para>
 242 <informalexample><para>Here we delete a calendar entry with <acronym>UID</acronym> <replaceable>&konsolekalendar;-1887551750.196</replaceable>:</para>
 243
 244 <para>
 245 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--delete</option> <option>--uid <replaceable>&konsolekalendar;-1887551750.196</replaceable></option></userinput></screen>
 246 </para>
 247 </informalexample>
 248 </para>
 249
 250 </sect1>
 251
 252 <sect1 id="changing">
 253 <title>Modifying Entries</title>
 254
 255 <para>&konsolekalendar; supports the modification of existing entries in a calendar
 256 file or resource using the <parameter>--change</parameter> command line argument.
 257 Calendar entries to be modified are specified exactly by their Unique-string
 258 identifier (<acronym>UID</acronym>) using the <parameter>--uid</parameter>
 259 option.  <acronym>UIDs</acronym> are found by first viewing the event,
 260 using the <parameter>--view</parameter> option.</para>
 261
 262 <para>
 263 Changing behaves in the same way as inserting: you can change an event's start date
 264 and time, end date and time, summary, location, and description.  Events
 265 successfully changed will be immediately shown modified within &kde; calendar
 266 applications (&korganizer;).</para>
 267
 268 <para><emphasis>Example:</emphasis> Here we change the summary and description
 269 of a calendar entry with <acronym>UID</acronym> <replaceable>&konsolekalendar;-1887551750.196</replaceable>:</para>
 270
 271 <para>
 272 <informalexample>
 273 <para>
 274 <prompt>%</prompt><userinput> <command>konsolekalendar</command>
 275 <option>--change</option> <option>--uid
 276 <replaceable>&konsolekalendar;-1887551750.196</replaceable></option>
 277 <option>--summary <replaceable>"Get my head examined"</replaceable></option> <option>--description <replaceable>"don't go to that doctor anymore!"</replaceable></option>
 278 </userinput>
 279 </para>
 280 </informalexample>
 281 </para>
 282
 283 </sect1>
 284
 285 <sect1 id="creating">
 286 <title>Creating a New Calendar File</title>
 287
 288 <para>&konsolekalendar; can be used to create a new &kde; calendar file.
 289 Since you cannot insert an entry into a calendar that does not exist,
 290 you must create the file first using the <parameter>--create</parameter>
 291 and <parameter>--file</parameter> command line arguments.</para>
 292
 293 <para>
 294 <informalexample><para>Create a calendar file named
 295 <filename><replaceable>/data/share/calendars/vacation.ics</replaceable></filename>:</para>
 296
 297 <para>
 298 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--create</option> <option>--file <replaceable>/data/share/calendars/vacation.ics</replaceable></option></userinput></screen>
 299 </para>
 300 </informalexample>
 301 </para>
 302
 303 </sect1>
 304
 305 <sect1 id="exporting">
 306 <title>Exporting to Other Formats</title>
 307
 308 <para>&konsolekalendar; can export a &kde; calendar to other well known formats.
 309 Exporting is a special form of viewing.  By default, events are viewed
 310 in <quote>&konsolekalendar; text</quote> format.  To change the viewing
 311 format use the <parameter>--export-type</parameter> command line argument.</para>
 312
 313 <para>To see a list of all supported export formats, use the
 314 <parameter>--export-list</parameter> option, as in:</para>
 315
 316 <para>
 317 <informalexample>
 318 <para>
 319 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--export-list</option></userinput></screen>
 320 </para>
 321 </informalexample>
 322 </para>
 323
 324 </sect1>
 325
 326 <sect1 id="formats">
 327 <title>Export Formats</title>
 328
 329 <para>Some, but not necessarily all, of the supported formats are
 330 described in the this section.</para>
 331
 332 <sect2 id="native-format">
 333 <title>&konsolekalendar; Text Format</title>
 334
 335 <para>&konsolekalendar; Text Format is &konsolekalendar;'s native format
 336 and is designed to be comfortable to read and to be parsed by follow-on
 337 scripts.</para>
 338
 339 <para>The &konsolekalendar; Text Format is:
 340 <informalexample>
 341 <screen>
 342 Date:\t&lt;Incidence Date&gt;(dddd yyyy-MM-dd)
 343 [\t&lt;Incidence Start Time&gt;(hh:mm) - &lt;Incidence End Time&gt;(hh:mm)]
 344 Summary:
 345 \t&lt;Incidence Summary | "(no summary available)"&gt;
 346 Location:
 347 \t&lt;Incidence Location | "(no location available)"&gt;
 348 Description:
 349 \t&lt;Incidence Description | "(no description available)"&gt;
 350 UID:
 351 \t&lt;Incidence UID&gt;
 352 --------------------------------------------------
 353 </screen>
 354 </informalexample>
 355 </para>
 356
 357 <para>For example:
 358 <informalexample>
 359 <screen>
 360 Date:   Tuesday 2003-11-01
 361         08:00 - 09:00
 362 Summary:
 363         Staff Meeting
 364 Location:
 365         Conference Room
 366 Description:
 367         Meet with the entire staff to discuss the project.
 368 UID:
 369         &konsolekalendar;-1128954167.1013
 370 --------------------------------------------------
 371 </screen>
 372 </informalexample>
 373 </para>
 374
 375 </sect2>
 376
 377 <sect2 id="short-format">
 378 <title>&konsolekalendar; Short Text Format</title>
 379
 380 <para>Short Text Format provides a more compact, less verbose version of
 381 &konsolekalendar;'s native format.</para>
 382
 383 <para>The &konsolekalendar; Short Text Format is:
 384 <informalexample>
 385 <screen>
 386 [--------------------------------------------------]
 387 {&lt;Incidence Date&gt;(dddd yyyy-MM-dd)]
 388 [&lt;Incidence Start Time&gt;(hh:mm) - &lt;Incidence End Time&gt;(hh:mm) | "\t"]
 389 \t&lt;Incidence Summary | \t&gt;[, &lt;Incidence Location&gt;]
 390 \t\t&lt;Incidence Description | "\t"&gt;
 391 </screen>
 392 </informalexample>
 393 </para>
 394
 395 <para>For example:
 396 <informalexample>
 397 <screen>
 398 --------------------------------------------------
 399 Tuesday 2003-11-01
 400 08:00 - 09:00   Staff Meeting, Conference Room
 401                 Meet with the entire staff to discuss the project.
 402 </screen>
 403 </informalexample>
 404 </para>
 405
 406 </sect2>
 407
 408 <sect2 id="csv-format">
 409 <title>Comma-Separated Values (<acronym>CSV</acronym>) Format</title>
 410
 411 <para>Comma-Separated Value Format displays the event values in the same order
 412 as &konsolekalendar; Text format. The only difference is that all the
 413 information is on the same row with each field separated by a comma.
 414 The resulting exported files can be imported directly into spreadsheet programs
 415 like &kspread;, <application>OpenOffice.org Calc</application>,
 416 and <application>&Microsoft; Excel</application>.
 417 Also, <acronym>CSV</acronym> format is easy to parse with follow-on scripts.</para>
 418
 419 <para>The Comma-Separated Value (<acronym>CSV</acronym>) format is:
 420 <informalexample>
 421 <screen>
 422 YYYY-MM-DD,HH:MM,YYYY-MM-DD,HH:MM,Summary,Location,Description,UID
 423 </screen>
 424 </informalexample>
 425 </para>
 426
 427 <para>For example:
 428 <informalexample>
 429 <screen>
 430 2003-11-01,08:00,2003-11-01,09:00,Staff Meeting,Conference Room,Meet in the big conference \
 431 room with the entire staff.,&konsolekalendar;-1128954167.1013
 432 </screen>
 433 </informalexample>
 434 </para>
 435
 436 </sect2>
 437
 438 <sect2 id="html-format">
 439 <title>&HTML; Format</title>
 440
 441 <para>The &HTML; export format will produce a valid
 442 &HTML; file that can be published to the <acronym>WWW</acronym>.
 443 This export format is not suitable for follow-on script parsing, but is
 444 very nice for publishing calendars for easy public viewing.</para>
 445
 446 <para><emphasis>TODO:</emphasis> Insert screenshot here</para>
 447
 448 </sect2>
 449
 450 <sect2 id="html-month-format">
 451 <title><acronym>HTMLmonth</acronym> Format</title>
 452
 453 <para>This format produces an &HTML; file showing
 454 all appointments in the months specified by the date range.
 455 This export format is not suitable for follow-on script parsing, but is
 456 very nice for publishing calendars for easy public viewing.</para>
 457
 458 <para><emphasis>TODO:</emphasis> Insert screenshot here</para>
 459
 460 </sect2>
 461
 462 </sect1>
 463
 464 <sect1 id="importing">
 465 <title>Importing Calendars</title>
 466
 467 <para>&konsolekalendar; can import an iCal or vCal calendar file into a &kde;
 468 calendar.  All events from the calendar being imported from will be inserted,
 469 including identical events.  In the next &konsolekalendar; release identical
 470 events will not be inserted.</para>
 471
 472 <para>
 473 <informalexample><para> To import calendar file
 474 <filename><replaceable>another.ics</replaceable></filename> into calendar
 475 <filename><replaceable>current.ics</replaceable></filename> run:</para>
 476
 477 <para>
 478 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--import <replaceable>another.ics</replaceable></option> <option>--file <replaceable>current.ics</replaceable></option></userinput></screen>
 479 </para>
 480 </informalexample>
 481 </para>
 482
 483 </sect1>
 484
 485 </chapter>
 486
 487 <chapter id="features-commandline-options">
 488 <title>Command Line Arguments</title>
 489
 490 <para>&konsolekalendar; supports the following options:</para>
 491
 492 <informaltable>
 493 <tgroup cols="2">
 494 <thead>
 495 <row>
 496   <entry>Option</entry>
 497   <entry>Description</entry>
 498 </row>
 499 </thead>
 500 <tbody>
 501 <row>
 502   <entry><option>--help, --help-all</option></entry>
 503   <entry>Shows help about the program options.</entry>
 504 </row>
 505 <row>
 506   <entry><option>--author</option></entry>
 507   <entry>Shows the program author information.</entry>
 508 </row>
 509 <row>
 510   <entry><option>-v, --version</option></entry>
 511   <entry>Shows the program version information.</entry>
 512 </row>
 513 <row>
 514   <entry><option>--license</option></entry>
 515   <entry>Shows the program license information.</entry>
 516 </row>
 517 <row>
 518   <entry><option>--verbose</option></entry>
 519   <entry>Print helpful runtime messages.</entry>
 520 </row>
 521 <row>
 522   <entry><option>--dry-run</option></entry>
 523   <entry>Print what would have been done, but do not execute.  Do not change any files; do not insert, remove, modify any existing files, nor create any new files.</entry>
 524 </row>
 525 <row>
 526   <entry><option>--allow-gui</option></entry>
 527   <entry>Permit resources which might need an interactive user interface. In normal operation, only resources which never will require a user interface are used (like file-based calendars).</entry>
 528 </row>
 529 <row>
 530   <entry><option>--file</option>
 531   <replaceable>&nbsp;calendar-file</replaceable></entry>
 532   <entry>Specify a calendar file to use.
 533   <para>If not specified then your default &korganizer; resource is used.</para></entry>
 534 </row>
 535 <row>
 536   <entry><emphasis>Major Operation Modes:</emphasis></entry>
 537 </row>
 538 <row>
 539   <entry><option>--view</option></entry>
 540   <entry>Print calendar events in specified export format.</entry>
 541 </row>
 542 <row>
 543   <entry><option>--add</option></entry>
 544   <entry>Insert an event into the calendar.</entry>
 545 </row>
 546 <row>
 547   <entry><option>--change</option></entry>
 548   <entry>Modify an existing calendar event.</entry>
 549 </row>
 550 <row>
 551   <entry><option>--delete</option></entry>
 552   <entry>Remove an existing calendar event.</entry>
 553 </row>
 554 <row>
 555   <entry><option>--create</option></entry>
 556   <entry>Create a new calendar file if one does not exist.</entry>
 557 </row>
 558 <row>
 559   <entry><option>--import</option>
 560  <replaceable>&nbsp;import-file</replaceable></entry>
 561   <entry>Import this calendar to the main calendar.</entry>
 562 </row>
 563 <row>
 564   <entry><emphasis>Operation modifiers:</emphasis></entry>
 565 </row>
 566 <row>
 567   <entry><option>--all</option></entry>
 568   <entry>View all calendar entries.</entry>
 569 </row>
 570 <row>
 571   <entry><option>--next</option></entry>
 572   <entry>View next activity in calendar.</entry>
 573 </row>
 574 <row>
 575   <entry><option>--show-next</option>
 576   <replaceable>&nbsp;days</replaceable></entry>
 577   <entry>Starting at specified date show next # days' activities.</entry>
 578 </row>
 579 <row>
 580   <entry><option>--uid</option>
 581   <replaceable>&nbsp;UID</replaceable></entry>
 582   <entry>View, delete, or change the event with this Unique-string IDentifier.</entry>
 583 </row>
 584 <row>
 585   <entry><option>--date</option>
 586   <replaceable>&nbsp;date</replaceable></entry>
 587   <entry>Start at this day [YYYY-MM-DD].  Default date is Today</entry>
 588 </row>
 589 <row>
 590   <entry><option>--time</option>
 591   <replaceable>&nbsp;time</replaceable></entry>
 592   <entry>Start at this time [HH:MM].  Default time for viewing is 07:00.
 593          <para>To add or change a floating event, use the <option>--time float</option>
 594          or the <option>--end-time float</option> options.</para></entry>
 595 </row>
 596 <row>
 597   <entry><option>--end-date</option>
 598   <replaceable>&nbsp;end-date</replaceable></entry>
 599   <entry>End at this day [YYYY-MM-DD].  Default is set by <option>--date</option>.</entry>
 600 </row>
 601 <row>
 602   <entry><option>--end-time</option>
 603   <replaceable>&nbsp;end-time</replaceable></entry>
 604   <entry>End at this time [HH:MM].   Default end-time for viewing is 17:00.
 605          <para>To add or change a floating event, use the <option>--time float</option>
 606          or the <option>--end-time float</option> options.</para></entry>
 607 </row>
 608 <row>
 609   <entry><option>--epoch-start</option>
 610   <replaceable>&nbsp;epoch-time</replaceable></entry>
 611   <entry>Start at this time [seconds since epoch].</entry>
 612 </row>
 613 <row>
 614   <entry><option>--epoch-end</option>
 615   <replaceable>&nbsp;epoch-time</replaceable></entry>
 616   <entry>End at this time [seconds since epoch].</entry>
 617 </row>
 618 <row>
 619   <entry><option>--summary</option>
 620   <replaceable>&nbsp;summary</replaceable></entry>
 621   <entry>Add summary to event (works with add and change).</entry>
 622 </row>
 623 <row>
 624   <entry><option>--description</option>
 625   <replaceable>&nbsp;description</replaceable></entry>
 626   <entry>Add description to event (works with add and change).</entry>
 627 </row>
 628 <row>
 629   <entry><option>--location</option>
 630   <replaceable>&nbsp;location</replaceable></entry>
 631   <entry>Add location to event (works with add and change).</entry>
 632 </row>
 633 <row>
 634   <entry><emphasis>Export options:</emphasis></entry>
 635 </row>
 636 <row>
 637   <entry><option>--export-type</option>
 638   <replaceable>&nbsp;export-type</replaceable></entry>
 639   <entry>Export file type.
 640   Default export file type is Text</entry>
 641 </row>
 642 <row>
 643   <entry><option>--export-file</option>
 644   <replaceable>&nbsp;export-file</replaceable></entry>
 645   <entry>Export to file.  By default, output is written to standard output.</entry>
 646 </row>
 647 <row>
 648   <entry><option>--export-list</option></entry>
 649   <entry>Print list of export types supported and exit.</entry>
 650 </row>
 651 </tbody>
 652 </tgroup>
 653 </informaltable>
 654
 655 </chapter>
 656
 657 <chapter id="faq">
 658 <title>Questions and Answers</title>
 659
 660 &reporting.bugs;
 661 &updating.documentation;
 662
 663 <qandaset id="faqlist">
 664 <qandaentry>
 665 <question>
 666 <para>What configuration files does &konsolekalendar; use?</para>
 667 </question>
 668 <answer>
 669 <para>None.</para>
 670 </answer>
 671 </qandaentry>
 672
 673
 674 <qandaentry>
 675 <question>
 676 <para>What are the application names of &konsolekalendar;?</para>
 677 </question>
 678 <answer>
 679 <para>&konsolekalendar;'s application name is <application>konsolekalendar</application>.</para>
 680 </answer>
 681 </qandaentry>
 682
 683 <qandaentry>
 684 <question>
 685 <para>What is the date specification format?</para>
 686 </question>
 687 <answer>
 688 <para>&konsolekalendar; will reject dates specified on the command line
 689 unless they are specified according to ISO 8601 standards, namely:
 690 YYYY-MM-DD.  Where YYYY represents a four-digit year (like 2003), MM
 691 represents a two-digit month (01,02,..,12), and DD represents a two-digit day
 692 (01,02,...,31).</para>
 693 <para>&konsolekalendar; always exports dates according to the ISO 8601 format.</para>
 694 </answer>
 695 </qandaentry>
 696
 697 <qandaentry>
 698 <question>
 699 <para>What is the time specification format?</para>
 700 </question>
 701 <answer>
 702 <para>&konsolekalendar; will reject times specified on the command line
 703 unless they are specified according to ISO 8601 standards, namely:
 704 HH:MM:SS.  Where HH represents a two-digit hour (01,02,...,24), MM
 705 represents a two-digit minute (01,02,..,60), and SS represents a two-digit
 706 second (01,02,...,60).</para>
 707 <para>&konsolekalendar; always exports times according to the ISO 8601 format.</para>
 708 </answer>
 709 </qandaentry>
 710
 711 <qandaentry>
 712 <question>
 713 <para>Will &konsolekalendar; insert a new event that is identical to one that
 714 already exists in the calendar?</para>
 715 </question>
 716 <answer>
 717 <para>No.  See next question.</para>
 718 </answer>
 719 </qandaentry>
 720
 721 <qandaentry>
 722 <question>
 723 <para>How does &konsolekalendar; determine if an event is identical to one that
 724 already exists in the calendar?</para>
 725 </question>
 726 <answer>
 727 <para>&konsolekalendar; checks the specified start date and time, end date and time,
 728 and summary against all events in the calendar.  An event match is determined
 729 if all three values match to an existing event.
 730 </para>
 731 </answer>
 732 </qandaentry>
 733
 734 <qandaentry>
 735 <question>
 736 <para>Can a non-floating event be changed to a floating event?</para>
 737 </question>
 738 <answer>
 739 <para>Yes.  Use the <option>--time float</option> option with <option>--change</option>.
 740 </para>
 741 </answer>
 742 </qandaentry>
 743
 744 <qandaentry>
 745 <question>
 746 <para>Why are event <acronym>UIDs</acronym> printed in most export formats?</para>
 747 </question>
 748 <answer>
 749 <para>Because you need to specify <acronym>UIDs</acronym> to delete or
 750 change events.
 751 If you do not want to see event <acronym>UIDs</acronym> then use the
 752 <emphasis>short</emphasis> export type (<option>--export-type short</option>).
 753 </para>
 754 </answer>
 755 </qandaentry>
 756
 757 <qandaentry>
 758 <question>
 759 <para>How do I have my question added to this <acronym>FAQ</acronym>?</para>
 760 </question>
 761 <answer>
 762 <para>Send your questions to <email>winter@kde.org</email>.</para>
 763 </answer>
 764 </qandaentry>
 765
 766 </qandaset>
 767 </chapter>
 768
 769
 770 <chapter id="credits">
 771
 772 <title>Credits and License</title>
 773
 774 <para>&konsolekalendar; Program copyright 2002-2007:</para>
 775
 776 <itemizedlist>
 777 <listitem><para>Tuukka Pasanen <email>illuusio@mailcity.com</email></para></listitem>
 778 <listitem><para>Allen Winter <email>winter@kde.org</email></para></listitem>
 779 </itemizedlist>
 780
 781 <para>Documentation copyright 2003:</para>
 782 <itemizedlist>
 783 <listitem><para>Allen Winter <email>winter@kde.org</email></para></listitem>
 784 <listitem><para>Tuukka Pasanen<email>illuusio@mailcity.com</email></para></listitem>
 785 </itemizedlist>
 786
 787 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 788
 789 &underFDL;               <!-- FDL: do not remove -->
 790
 791 &underGPL;               <!-- GPL License -->
 792
 793 </chapter>
 794
 795 <appendix id="installation">
 796 <title>Installation</title>
 797
 798 <sect1 id="obtaining-application">
 799 <title>How to obtain &konsolekalendar;</title>
 800
 801 &install.intro.documentation;
 802
 803 <para>&konsolekalendar; comes included with &kde;4 and is not available separately.
 804 </para>
 805
 806 </sect1>
 807
 808 <sect1 id="requirements">
 809 <title>Requirements</title>
 810
 811 <para>&konsolekalendar; requires the standard &kde; libraries to be installed
 812 (the <filename>kdelibs</filename> package and <filename>kdepimlibs</filename>).
 813 To compile from source, you also need the &Qt;, <filename>kdelibs</filename> and
 814 <filename>kdepimlibs</filename> development packages.</para>
 815
 816 <para>You can find a list of changes in the
 817 <filename>ChangeLog</filename> file.</para>
 818 </sect1>
 819
 820 <sect1 id="configuration">
 821 <title>Configuration</title>
 822
 823 <para>No special configuration is required to set up &konsolekalendar; to run
 824 on the &kde; desktop.</para>
 825
 826 </sect1>
 827
 828 </appendix>
 829
 830 &documentation.index;
 831 </book>
 832 <!--
 833 Local Variables:
 834 mode: sgml
 835 sgml-minimize-attributes:nil
 836 sgml-general-insert-case:lower
 837 sgml-indent-step:0
 838 sgml-indent-data:nil
 839 End:
 840 -->