Warning, /pim/akonadi-calendar-tools/doc/konsolekalendar/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003 "dtd/kdedbx45.dtd" [
0004 
0005   <!ENTITY konsolekalendar "<application>KonsoleKalendar</application>">
0006   <!ENTITY % addindex "IGNORE">
0007   <!ENTITY % English "INCLUDE">
0008 ]>
0009 <!-- The language must NOT be changed here. -->
0010 
0011 <book id="konsolekalendar" lang="&language;">
0012 
0013 <bookinfo id="konsolekalendarinfo">
0014 
0015 <title>The &konsolekalendar; Handbook</title>
0016 
0017 <authorgroup>
0018 <author>
0019 <firstname>Tuukka</firstname>
0020 <surname>Pasanen</surname>
0021 <affiliation><address><email>illuusio@mailcity.com</email></address></affiliation>
0022 </author>
0023 
0024 <author>
0025 <firstname>Allen</firstname>
0026 <surname>Winter</surname>
0027 <affiliation><address><email>winterz@kde.org</email></address></affiliation>
0028 </author>
0029 
0030 <othercredit role="reviewer">
0031 <firstname>Malcolm</firstname>
0032 <surname>Hunter</surname>
0033 <affiliation><address><email>malcolm.hunter@gmx.co.uk</email></address></affiliation>
0034 <contrib>Reviewer</contrib>
0035 </othercredit>
0036 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0037 </authorgroup>
0038 
0039 <copyright>
0040 <year>2002</year><year>2004</year><holder>Tuukka Pasanen</holder>
0041 </copyright>
0042 
0043 <copyright>
0044 <year>2003</year><year>2007</year><holder>Allen Winter</holder>
0045 </copyright>
0046 
0047 <legalnotice>&FDLNotice;</legalnotice>
0048 
0049 <!-- Don't change format of date and version of the documentation -->
0050 
0051 <date>2016-11-23</date>
0052 <releaseinfo>5.1.3 (Applications 16.12)</releaseinfo>
0053 
0054 <abstract>
0055 <para>&konsolekalendar; is a command line interface to &kde; calendars.</para>
0056 </abstract>
0057 
0058 
0059 <keywordset>
0060 <keyword>KDE</keyword>
0061 <keyword>&package;</keyword>
0062 <keyword>&kappname;</keyword>
0063 <keyword>KOrganizer</keyword>
0064 </keywordset>
0065 
0066 </bookinfo>
0067 
0068 <chapter id="introduction">
0069 <title>Introduction</title>
0070 
0071 <para>&konsolekalendar; is a command line interface to calendars.
0072 It lets you view, insert, remove, or modify calendar events by way of
0073 the command line or from a scripting language.
0074 Additionally, &konsolekalendar; can create a new calendar,
0075 export a calendar to a variety of other formats, and
0076 import another calendar.</para>
0077 
0078 <para>In its basic mode, &konsolekalendar; displays the list of
0079 events in your default calendar for the current day (from 7:00 to 17:00).</para>
0080 
0081 <para>Main features of &konsolekalendar;:
0082 <itemizedlist>
0083 <listitem><para>View calendar entries from a start date/time to end date/time</para></listitem>
0084 <listitem><para>Insert (add) calendar entries</para></listitem>
0085 <listitem><para>Remove (delete) calendar entries</para></listitem>
0086 <listitem><para>Modify (change) calendar entries</para></listitem>
0087 <listitem><para>Create a new calendar</para></listitem>
0088 <listitem><para>Export calendar entries to other file formats</para></listitem>
0089 <listitem><para>Import an existing calendar</para></listitem>
0090 </itemizedlist></para>
0091 
0092 <para>&konsolekalendar; is <emphasis>not</emphasis> another graphical
0093 user interface to a &kde; calendar (i.e. &korganizer;).  &konsolekalendar;
0094 is intended solely for uses where a graphical user interface is
0095 not practical or possible.</para>
0096 
0097 <para>&konsolekalendar; does <emphasis>not</emphasis> provide a full-featured
0098 language for making queries of the user's calendar: nor is it the intention
0099 of the authors to ever write such a capability.  Primitive command line
0100 options are provided for accessing calendar events within a consecutive
0101 range of dates/time stamps.
0102 </para>
0103 
0104 </chapter>
0105 
0106 <chapter id="features">
0107 <title>Features</title>
0108 <para>In this chapter you'll learn about the main features of
0109 &konsolekalendar; and how to control them using the command line parameters
0110 (remember that &konsolekalendar; is not a graphical user interface;
0111 it is a command line program only).</para>
0112 
0113 <para>
0114 You'll learn about inserting, deleting, and changing
0115 calendar events, and how to export events to other file formats.
0116 The creation and importation of calendars will also be covered
0117 in this chapter.
0118 </para>
0119 
0120 <sect1 id="viewing">
0121 <title>Viewing Events</title>
0122 
0123 <para>In its default mode, or by using the <parameter>--view</parameter>
0124 option, &konsolekalendar; will list all events within the range of a specified
0125 date/time.</para>
0126 
0127 <para>
0128 <informalexample><para>To view all of today's events (from 7:00 to 17:00), simply run:</para>
0129 
0130 <para>
0131 <screen>
0132 <prompt>%</prompt><userinput> <command>konsolekalendar</command>
0133 </userinput>
0134 </screen>
0135 </para>
0136 </informalexample>
0137 </para>
0138 
0139 <para>
0140 <informalexample><para>In this next example, we view all events for the week of August 18-22:</para>
0141 
0142 <para>
0143 <screen>
0144 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--view</option> <option>--date <replaceable>2016-08-18</replaceable> </option> <option>--end-date <replaceable>2016-08-22</replaceable></option>
0145 </userinput>
0146 </screen>
0147 </para>
0148 </informalexample>
0149 </para>
0150 
0151 <para>
0152 <informalexample><para>Show the next event(s) on the calendar from the current time forward:</para>
0153 
0154 <para>
0155 <screen>
0156 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--next</option>
0157 </userinput>
0158 </screen>
0159 </para>
0160 </informalexample>
0161 </para>
0162 
0163 <para>
0164 <informalexample><para>To view all events for the next 5 days run:</para>
0165 
0166 <para>
0167 <screen>
0168 <prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--show-next</option> <replaceable>5</replaceable>
0169 
0170 </userinput>
0171 </screen>
0172 </para>
0173 </informalexample>
0174 </para>
0175 
0176 </sect1>
0177 
0178 <sect1 id="inserting">
0179 <title>Inserting Events</title>
0180 
0181 <para>&konsolekalendar; can insert events into a calendar or calendar
0182 resource using the <parameter>--add</parameter> command line argument.
0183 Events successfully inserted will be immediately shown by &kde; calendar
0184 applications (like &korganizer;).</para>
0185 
0186 <para>You get a list of all calendars and their id's using:
0187 </para>
0188 
0189 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--list-calendars</option></userinput></screen>
0190 
0191 <para>
0192 <informalexample><para>In the following example, an event starting on 2016-12-01 (December 1, 2016)
0193 at 10:00 and ending at 12:00 with summary "Doctor Visit" will be
0194 inserted into the user's calendar resource with the id 8:</para>
0195 
0196 
0197 <para>
0198 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--calendar 8</option> <option>--date <replaceable>2016-12-03</replaceable></option> <option>--time <replaceable>10:00</replaceable></option> \
0199 <option>--end-time <replaceable>12:00</replaceable></option> <option>--summary <replaceable>"Doctor Visit"</replaceable></option></userinput></screen>
0200 </para>
0201 </informalexample>
0202 </para>
0203 
0204 <para>
0205 <informalexample><para>In this example, a birthday event is added into the
0206 user's calendar resource with the id 8:</para>
0207 
0208 <para>
0209 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--calendar 8</option> <option>--date <replaceable>2016-12-06</replaceable></option> <option>--summary <replaceable>"My Birthday"</replaceable></option> \
0210 <option>--description <replaceable>"Party Time"</replaceable></option></userinput></screen>
0211 </para>
0212 </informalexample>
0213 </para>
0214 
0215 <para>
0216 <informalexample><para> Here a one week vacation is inserted into a calendar with the id 8:</para>
0217 
0218 <para>
0219 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--add</option> <option>--calendar <replaceable>12</replaceable></option> <option>--date <replaceable>2017-08-01</replaceable></option> \
0220 <option>--end-date <replaceable>2017-08-07</replaceable></option> <option>--summary <replaceable>"Vacation"</replaceable></option> <option>--description <replaceable>"Nobody will ever find me!"</replaceable></option></userinput></screen>
0221 </para>
0222 </informalexample>
0223 </para>
0224 
0225 </sect1>
0226 
0227 <sect1 id="deleting">
0228 <title>Removing Entries</title>
0229 
0230 <para>&konsolekalendar; supports the removal of entries in a calendar file or
0231 resource using the <parameter>--delete</parameter> command line argument.
0232 Calendar entries to be removed are specified exactly by their Unique-string
0233 identifier (<acronym>UID</acronym>) using the <parameter>--uid</parameter>
0234 option.  <acronym>UIDs</acronym> are found by first viewing the event,
0235 using the <parameter>--view</parameter>, <parameter>--next</parameter>
0236 or <parameter>--show-next</parameter> options.</para>
0237 
0238 <para>Events successfully deleted will be immediately removed from within &kde; calendar
0239 applications (&korganizer; for example).</para>
0240 
0241 <warning><para> When you delete something from the calendar you
0242 <emphasis>cannot</emphasis> undo it! In other words, when you delete an entry
0243 you cannot reverse the deletion. It's gone for good.</para></warning>
0244 
0245 <para>
0246 <informalexample><para>Here we delete a calendar entry with <acronym>UID</acronym> <replaceable>&konsolekalendar;-1887551750.196</replaceable>:</para>
0247 
0248 <para>
0249 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--delete</option> <option>--uid <replaceable>&konsolekalendar;-1887551750.196</replaceable></option></userinput></screen>
0250 </para>
0251 </informalexample>
0252 </para>
0253 
0254 </sect1>
0255 
0256 <sect1 id="changing">
0257 <title>Modifying Entries</title>
0258 
0259 <para>&konsolekalendar; supports the modification of existing entries in a calendar
0260 file or resource using the <parameter>--change</parameter> command line argument.
0261 Calendar entries to be modified are specified exactly by their Unique-string
0262 identifier (<acronym>UID</acronym>) using the <parameter>--uid</parameter>
0263 option.  <acronym>UIDs</acronym> are found by first viewing the event,
0264 using the <parameter>--view</parameter>, <parameter>--next</parameter>
0265 or <parameter>--show-next</parameter> options.</para>
0266 
0267 <para>
0268 Changing behaves in the same way as inserting: you can change an event's start date 
0269 and time, end date and time, summary, location, and description.  Events
0270 successfully changed will be immediately shown modified within &kde; calendar
0271 applications (&korganizer;).</para>
0272 
0273 <para><emphasis>Example:</emphasis> Here we change the summary and description
0274 of a calendar entry with <acronym>UID</acronym> <replaceable>&konsolekalendar;-1887551750.196</replaceable>:</para>
0275 
0276 <para>
0277 <informalexample>
0278 <para>
0279 <prompt>%</prompt><userinput> <command>konsolekalendar</command>
0280 <option>--change</option> <option>--uid
0281 <replaceable>&konsolekalendar;-1887551750.196</replaceable></option>
0282 <option>--summary <replaceable>"Get my head examined"</replaceable></option> <option>--description <replaceable>"don't go to that doctor anymore!"</replaceable></option>
0283 </userinput>
0284 </para>
0285 </informalexample>
0286 </para>
0287 
0288 </sect1>
0289 
0290 <sect1 id="creating">
0291 <title>Creating a New Calendar File</title>
0292 
0293 <para>&konsolekalendar;  can be used to create new calendars from existing files.
0294 You can create the calendar using the option <option>--create</option>
0295 with the filename as argument.
0296 The file must be a valid <acronym>iCal</acronym> or <acronym>vCal</acronym> file.</para>
0297 <para>Note: You can not use the option <option>--dry-run</option> to test if
0298 the resource can be created.</para>
0299 
0300 <para>Note: &konsolekalendar; needs the file to work, so never delete the file by hand.
0301 </para>
0302 
0303 <para>Technical sidenote: &konsolekalendar; creates with this command a new <acronym>Akonadi</acronym> resource pointing to this file.
0304 It does not prevent you to create multiple resources pointing to the same file.
0305 </para>
0306 
0307 <para>
0308 <informalexample><para>Create a new calendar from an existing file named
0309 <filename><replaceable>vacation.ics</replaceable></filename>:</para>
0310 <para>
0311 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--create</option> <option><replaceable>vacation.ics</replaceable></option></userinput></screen>
0312 </para>
0313 </informalexample>
0314 </para>
0315 
0316 <para>The resource will be named <quote>vacation</quote> using <option>--list-calendars</option></para>
0317 
0318 <para>It is not possible to delete an <acronym>Akonadi</acronym> resource with &konsolekalendar;, you
0319 have to use &korganizer; or <application>akonadiconsole</application>.
0320 </para>
0321 
0322 </sect1>
0323 
0324 <sect1 id="exporting">
0325 <title>Exporting to Other Formats</title>
0326 
0327 <para>&konsolekalendar; can export a calendar to other well known formats.
0328 Exporting is a special form of viewing.  By default, events are viewed
0329 in <quote>&konsolekalendar; text</quote> format.  To change the viewing
0330 format use the <parameter>--export-type</parameter> command line argument.</para>
0331 
0332 <para>To see a list of all supported export formats, use the
0333 <parameter>--export-list</parameter> option, as in:</para>
0334 
0335 <para>
0336 <informalexample>
0337 <para>
0338 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--export-list</option></userinput></screen>
0339 </para>
0340 </informalexample>
0341 </para>
0342 
0343 </sect1>
0344 
0345 <sect1 id="formats">
0346 <title>Export Formats</title>
0347 
0348 <para>Some, but not necessarily all, of the supported formats are
0349 described in the this section.</para>
0350 
0351 <sect2 id="native-format">
0352 <title>&konsolekalendar; Text Format</title>
0353 
0354 <para>&konsolekalendar; Text Format is &konsolekalendar;'s native format
0355 and is designed to be comfortable to read and to be parsed by follow-on
0356 scripts.</para>
0357 
0358 <para>The &konsolekalendar; Text Format is:
0359 <informalexample>
0360 <screen>
0361 Date:\t&lt;Incidence Date&gt;(dddd yyyy-MM-dd)
0362 [\t&lt;Incidence Start Time&gt;(hh:mm) - &lt;Incidence End Time&gt;(hh:mm)]
0363 Summary:
0364 \t&lt;Incidence Summary | "(no summary available)"&gt;
0365 Location:
0366 \t&lt;Incidence Location | "(no location available)"&gt;
0367 Description:
0368 \t&lt;Incidence Description | "(no description available)"&gt;
0369 UID:
0370 \t&lt;Incidence UID&gt;
0371 --------------------------------------------------
0372 </screen>
0373 </informalexample>
0374 </para>
0375 
0376 <para>Output of <userinput> <command>konsolekalendar</command> <option>--next</option> <option>--export-type</option> <option>Text</option></userinput>:
0377 <informalexample>
0378 <screen>
0379 Date:   Tuesday 2016-11-29
0380         08:00 - 09:00
0381 Summary:
0382         Staff Meeting
0383 Location:
0384         Conference Room
0385 Description:
0386         Meet with the entire staff to discuss the project.
0387 UID:
0388         &konsolekalendar;-1924621834.134
0389 --------------------------------------------------
0390 </screen>
0391 </informalexample>
0392 </para>
0393 
0394 </sect2>
0395 
0396 <sect2 id="short-format">
0397 <title>&konsolekalendar; Short Text Format</title>
0398 
0399 <para>Short Text Format provides a more compact, less verbose version of
0400 &konsolekalendar;'s native format.</para>
0401 
0402 <para>The &konsolekalendar; Short Text Format is:
0403 <informalexample>
0404 <screen>
0405 [--------------------------------------------------]
0406 {&lt;Incidence Date&gt;(dddd yyyy-MM-dd)]
0407 [&lt;Incidence Start Time&gt;(hh:mm) - &lt;Incidence End Time&gt;(hh:mm) | "\t"]
0408 \t&lt;Incidence Summary | \t&gt;[, &lt;Incidence Location&gt;]
0409 \t\t&lt;Incidence Description | "\t"&gt;
0410 </screen>
0411 </informalexample>
0412 </para>
0413 
0414 <para>Output of <userinput> <command>konsolekalendar</command> <option>--next</option> <option>--export-type</option> <option>Short</option></userinput>:
0415 <informalexample>
0416 <screen>
0417 --------------------------------------------------
0418 Tuesday 2016-11-29
0419 08:00 - 09:00   Staff Meeting, Conference Room
0420                 Meet with the entire staff to discuss the project.
0421 </screen>
0422 </informalexample>
0423 </para>
0424 
0425 </sect2>
0426 
0427 <sect2 id="csv-format">
0428 <title>Comma-Separated Values (<acronym>CSV</acronym>) Format</title>
0429 
0430 <para>Comma-Separated Value Format displays the event values in the same order
0431 as &konsolekalendar; Text format. The only difference is that all the
0432 information is on the same row with each field separated by a comma.
0433 The resulting exported files can be imported directly into spreadsheet programs
0434 like &calligrasheets;, <application>OpenOffice.org Calc</application>,
0435 and <application>&Microsoft; Excel</application>.
0436 Also, <acronym>CSV</acronym> format is easy to parse with follow-on scripts.</para>
0437 
0438 <para>The Comma-Separated Value (<acronym>CSV</acronym>) format is:
0439 <informalexample>
0440 <screen>
0441 "Weekday, Month Day, Year","HH:MM","Weekday, Month Day, Year","HH:MM","Summary","Location","Description","UID"
0442 </screen>
0443 </informalexample>
0444 </para>
0445 
0446 <para>Output of <userinput> <command>konsolekalendar</command> <option>--next</option> <option>--export-type</option> <option>CSV</option></userinput>:
0447 <informalexample>
0448 <screen>
0449 "Tuesday, November 29, 2016","08:00","Tuesday, November 29, 2016","09:00","Staff Meeting","Conference Room","Meet in the big conference \
0450 room with the entire staff.","&konsolekalendar;-1924621834.134"
0451 </screen>
0452 </informalexample>
0453 </para>
0454 
0455 </sect2>
0456 
0457 </sect1>
0458 
0459 <sect1 id="importing">
0460 <title>Importing Calendars</title>
0461 
0462 <para>&konsolekalendar; can import an iCal or vCal calendar file into
0463 calendar.  All events from the calendar being imported from will be inserted,
0464 skipping identical events, that are already part of the calendar.</para>
0465 
0466 <para>
0467 <informalexample><para> To import calendar file
0468 <replaceable>vacation.ics</replaceable> into calendar
0469 with the id <replaceable>8</replaceable> run:</para>
0470 
0471 <para>
0472 <screen><prompt>%</prompt><userinput> <command>konsolekalendar</command> <option>--import <replaceable>vacation.ics</replaceable></option> <option>--calendar <replaceable>8</replaceable></option></userinput></screen>
0473 </para>
0474 </informalexample>
0475 </para>
0476 
0477 </sect1>
0478 
0479 </chapter>
0480 
0481 <chapter id="features-commandline-options">
0482 <title>Command Line Arguments</title>
0483 
0484 <para>&konsolekalendar; supports the following options:</para>
0485 
0486 <informaltable>
0487 <tgroup cols="2">
0488 <thead>
0489 <row>
0490   <entry>Option</entry>
0491   <entry>Description</entry>
0492 </row>
0493 </thead>
0494 <tbody>
0495 <row>
0496   <entry><emphasis>Generic options:</emphasis></entry>
0497 </row>
0498 <row>
0499   <entry><option>--help, --help-all</option></entry>
0500   <entry>Shows help about the program options.</entry>
0501 </row>
0502 <row>
0503   <entry><option>--author</option></entry>
0504   <entry>Shows the program author information.</entry>
0505 </row>
0506 <row>
0507   <entry><option>-v, --version</option></entry>
0508   <entry>Shows the program version information.</entry>
0509 </row>
0510 <row>
0511   <entry><option>--license</option></entry>
0512   <entry>Shows the program license information.</entry>
0513 </row>
0514 <row>
0515   <entry><emphasis>Options:</emphasis></entry>
0516 </row>
0517 <row>
0518   <entry><option>--verbose</option></entry>
0519   <entry>Print helpful runtime messages.</entry>
0520 </row>
0521 <row>
0522   <entry><option>--dry-run</option></entry>
0523   <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>
0524 </row>
0525 <row>
0526   <entry><option>--allow-gui</option></entry>
0527   <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>
0528 </row>
0529 <row>
0530   <entry><emphasis>Incidence types (these options can be combined):</emphasis></entry>
0531 </row>
0532 <row>
0533   <entry><option>--event</option></entry>
0534   <entry>Operate for Events only (Default).</entry>
0535 </row>
0536 <row>
0537   <entry><option>--todo</option></entry>
0538   <entry>Operate for Todos only. (Not implemented)</entry>
0539 </row>
0540 <row>
0541   <entry><option>--journal</option></entry>
0542   <entry>Operate for Journals only. (Not implemented)</entry>
0543 </row>
0544 <row>
0545   <entry><emphasis>Major Operation Modes:</emphasis></entry>
0546 </row>
0547 <row>
0548   <entry><option>--view</option></entry>
0549   <entry>Print calendar events in specified export format.</entry>
0550 </row>
0551 <row>
0552   <entry><option>--add</option></entry>
0553   <entry>Insert an event into the calendar.</entry>
0554 </row>
0555 <row>
0556   <entry><option>--change</option></entry>
0557   <entry>Modify an existing calendar event.</entry>
0558 </row>
0559 <row>
0560   <entry><option>--delete</option></entry>
0561   <entry>Remove an existing calendar event.</entry>
0562 </row>
0563 <row>
0564   <entry><option>--create</option>
0565   <replaceable>&nbsp;filename</replaceable>
0566   </entry>
0567   <entry>Create a new calendar from existing file.</entry>
0568 </row>
0569 <row>
0570   <entry><option>--import</option>
0571  <replaceable>&nbsp;import-file</replaceable></entry>
0572   <entry>Import this calendar to the main calendar.</entry>
0573 </row>
0574 <row>
0575   <entry><option>--list-calendars</option></entry>
0576   <entry>List available calendars.</entry>
0577 </row>
0578 <row>
0579   <entry><emphasis>Operation modifiers:</emphasis></entry>
0580 </row>
0581 <row>
0582   <entry><option>--all</option></entry>
0583   <entry>View all calendar entries.</entry>
0584 </row>
0585 <row>
0586   <entry><option>--next</option></entry>
0587   <entry>View next activity in calendar.</entry>
0588 </row>
0589 <row>
0590   <entry><option>--show-next</option>
0591   <replaceable>&nbsp;days</replaceable></entry>
0592   <entry>Starting at specified date show next # days' activities.</entry>
0593 </row>
0594 <row>
0595   <entry><option>--uid</option>
0596   <replaceable>&nbsp;UID</replaceable></entry>
0597   <entry>View, delete, or change the event with this Unique-string IDentifier.</entry>
0598 </row>
0599 <row>
0600   <entry><option>--date</option>
0601   <replaceable>&nbsp;date</replaceable></entry>
0602   <entry>Start at this day [YYYY-MM-DD].  Default date is Today</entry>
0603 </row>
0604 <row>
0605   <entry><option>--time</option>
0606   <replaceable>&nbsp;time</replaceable></entry>
0607   <entry>Start at this time [HH:MM].  Default time for viewing is 07:00.
0608          <para>To add or change a floating event, use the <option>--time float</option>
0609          or the <option>--end-time float</option> options.</para></entry>
0610 </row>
0611 <row>
0612   <entry><option>--end-date</option>
0613   <replaceable>&nbsp;end-date</replaceable></entry>
0614   <entry>End at this day [YYYY-MM-DD].  Default is set by <option>--date</option>.</entry>
0615 </row>
0616 <row>
0617   <entry><option>--end-time</option>
0618   <replaceable>&nbsp;end-time</replaceable></entry>
0619   <entry>End at this time [HH:MM].   Default end-time for viewing is 17:00.
0620          <para>To add or change a floating event, use the <option>--time float</option>
0621          or the <option>--end-time float</option> options.</para></entry>
0622 </row>
0623 <row>
0624   <entry><option>--epoch-start</option>
0625   <replaceable>&nbsp;epoch-time</replaceable></entry>
0626   <entry>Start at this time [seconds since epoch].</entry>
0627 </row>
0628 <row>
0629   <entry><option>--epoch-end</option>
0630   <replaceable>&nbsp;epoch-time</replaceable></entry>
0631   <entry>End at this time [seconds since epoch].</entry>
0632 </row>
0633 <row>
0634   <entry><option>--summary</option>
0635   <replaceable>&nbsp;summary</replaceable></entry>
0636   <entry>Add summary to event (works with add and change).</entry>
0637 </row>
0638 <row>
0639   <entry><option>--description</option>
0640   <replaceable>&nbsp;description</replaceable></entry>
0641   <entry>Add description to event (works with add and change).</entry>
0642 </row>
0643 <row>
0644   <entry><option>--location</option>
0645   <replaceable>&nbsp;location</replaceable></entry>
0646   <entry>Add location to event (works with add and change).</entry>
0647 </row>
0648 <row>
0649   <entry><option>--calendar</option>
0650   <replaceable>&nbsp;id</replaceable></entry>
0651   <entry>Specify a calendar to use.
0652   <para>If not specified then your default &korganizer; resource is used.</para></entry>
0653 </row>
0654 <row>
0655   <entry><emphasis>Export options:</emphasis></entry>
0656 </row>
0657 <row>
0658   <entry><option>--export-type</option>
0659   <replaceable>&nbsp;export-type</replaceable></entry>
0660   <entry>Export file type.
0661   Default export file type is Text</entry>
0662 </row>
0663 <row>
0664   <entry><option>--export-file</option>
0665   <replaceable>&nbsp;export-file</replaceable></entry>
0666   <entry>Export to file.  By default, output is written to standard output.</entry>
0667 </row>
0668 <row>
0669   <entry><option>--export-list</option></entry>
0670   <entry>Print list of export types supported and exit.</entry>
0671 </row>
0672 </tbody>
0673 </tgroup>
0674 </informaltable>
0675 
0676 </chapter>
0677 
0678 <chapter id="faq">
0679 <title>Questions and Answers</title>
0680 
0681 <qandaset id="faqlist">
0682 <qandaentry>
0683 <question>
0684 <para>What configuration files does &konsolekalendar; use?</para>
0685 </question>
0686 <answer>
0687 <para>None.</para>
0688 </answer>
0689 </qandaentry>
0690 
0691 
0692 <qandaentry>
0693 <question>
0694 <para>What are the application names of &konsolekalendar;?</para>
0695 </question>
0696 <answer>
0697 <para>&konsolekalendar;'s application name is <application>konsolekalendar</application>.</para>
0698 </answer>
0699 </qandaentry>
0700 
0701 <qandaentry>
0702 <question>
0703 <para>What is the date specification format?</para>
0704 </question>
0705 <answer>
0706 <para>&konsolekalendar; will reject dates specified on the command line
0707 unless they are specified according to ISO 8601 standards, namely:
0708 YYYY-MM-DD.  Where YYYY represents a four-digit year (like 2003), MM
0709 represents a two-digit month (01,02,..,12), and DD represents a two-digit day
0710 (01,02,...,31).</para>
0711 <para>&konsolekalendar; always exports dates according to the ISO 8601 format.</para>
0712 </answer>
0713 </qandaentry>
0714 
0715 <qandaentry>
0716 <question>
0717 <para>What is the time specification format?</para>
0718 </question>
0719 <answer>
0720 <para>&konsolekalendar; will reject times specified on the command line
0721 unless they are specified according to ISO 8601 standards, namely:
0722 HH:MM:SS.  Where HH represents a two-digit hour (01,02,...,24), MM
0723 represents a two-digit minute (01,02,..,60), and SS represents a two-digit
0724 second (01,02,...,60).</para>
0725 <para>&konsolekalendar; always exports times according to the ISO 8601 format.</para>
0726 </answer>
0727 </qandaentry>
0728 
0729 <qandaentry>
0730 <question>
0731 <para>Will &konsolekalendar; insert a new event that is identical to one that
0732 already exists in the calendar?</para>
0733 </question>
0734 <answer>
0735 <para>No.  See next question.</para>
0736 </answer>
0737 </qandaentry>
0738 
0739 <qandaentry>
0740 <question>
0741 <para>How does &konsolekalendar; determine if an event is identical to one that
0742 already exists in the calendar?</para>
0743 </question>
0744 <answer>
0745 <para>&konsolekalendar; checks the specified start date and time, end date and time,
0746 and summary against all events in the calendar.  An event match is determined
0747 if all three values match to an existing event.
0748 </para>
0749 </answer>
0750 </qandaentry>
0751 
0752 <qandaentry>
0753 <question>
0754 <para>Can a non-floating event be changed to a floating event?</para>
0755 </question>
0756 <answer>
0757 <para>Yes.  Use the <option>--time float</option> option with <option>--change</option>.
0758 </para>
0759 </answer>
0760 </qandaentry>
0761 
0762 <qandaentry>
0763 <question>
0764 <para>Why are event <acronym>UIDs</acronym> printed in most export formats?</para>
0765 </question>
0766 <answer>
0767 <para>Because you need to specify <acronym>UIDs</acronym> to delete or
0768 change events.
0769 If you do not want to see event <acronym>UIDs</acronym> then use the
0770 <emphasis>short</emphasis> export type (<option>--export-type short</option>).
0771 </para>
0772 </answer>
0773 </qandaentry>
0774 
0775 <qandaentry>
0776 <question>
0777 <para>How do I have my question added to this <acronym>FAQ</acronym>?</para>
0778 </question>
0779 <answer>
0780 <para>Send your questions to <email>winter@kde.org</email>.</para>
0781 </answer>
0782 </qandaentry>
0783 
0784 </qandaset>
0785 </chapter>
0786 
0787 
0788 <chapter id="credits">
0789 
0790 <title>Credits and License</title>
0791 
0792 <para>&konsolekalendar; Program copyright 2002-2007:</para>
0793 
0794 <itemizedlist>
0795 <listitem><para>Tuukka Pasanen <email>illuusio@mailcity.com</email></para></listitem>
0796 <listitem><para>Allen Winter <email>winter@kde.org</email></para></listitem>
0797 </itemizedlist>
0798 
0799 <para>Documentation copyright 2003:</para>
0800 <itemizedlist>
0801 <listitem><para>Allen Winter <email>winter@kde.org</email></para></listitem>
0802 <listitem><para>Tuukka Pasanen <email>illuusio@mailcity.com</email></para></listitem>
0803 </itemizedlist>
0804 
0805 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0806 
0807 &underFDL;               <!-- FDL: do not remove -->
0808 
0809 &underGPL;               <!-- GPL License -->
0810 
0811 </chapter>
0812 
0813 &documentation.index;
0814 </book>
0815 <!--
0816 Local Variables:
0817 mode: sgml
0818 sgml-minimize-attributes:nil
0819 sgml-general-insert-case:lower
0820 sgml-indent-step:0
0821 sgml-indent-data:nil
0822 End:
0823 -->