<?xml version="1.0" ?>
<!-- TODO:
     Change license to LGPL?
     Format for date (YYYY-MM-DD)  and time (HH:MM) specifications
     Search for other TODOs in this file
     END TODO -->
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
  <!-- Define an entity for your application if it is not part of KDE CVS -->
  <!ENTITY konsolekalendar "<application
>KonsoleKalendar</application
>">
  <!ENTITY kappname "&konsolekalendar;"
><!-- replace kmyapplication here
                                             do *not* replace kappname-->
  <!ENTITY package "kde-pim"
><!-- kdebase, kdeadmin, etc.  Leave
                                  this unchanged if your
                                  application is not maintained in KDE CVS -->
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % Russian "INCLUDE"
> <!-- ONLY If you are writing non-English
                                     original documentation, change
                                     the language here -->
]>
<!-- The language must NOT be changed here. -->

<book lang="&language;">

<bookinfo>

<title
>Справочное руководство по &konsolekalendar;</title>

<authorgroup>
<author
><firstname
>Tuukka</firstname
> <surname
>Pasanen</surname
> <affiliation
> <address
><email
>illuusio@mailcity.com</email
></address>
</affiliation>
</author>

<othercredit role="developer"
><firstname
>Allen</firstname
> <surname
>Winter</surname
> <affiliation
><address
><email
>winterz@earthlink.net</email
></address
></affiliation>
<contrib
>Разработчики</contrib>
</othercredit>
</authorgroup>

<othercredit role="translator"
><firstname
>Nick</firstname
><surname
> </surname
><affiliation
><address
><email
>blindguard@mtu-net.ru</email
></address
></affiliation
><contrib
></contrib
></othercredit
> 

<copyright>
<year
>2002</year
><year
>2003</year
><holder
>Tuukka Pasanen</holder>
</copyright>

<copyright>
<year
>2003</year>
<holder
>Allen D. Winter</holder>
</copyright>

<legalnotice
>&FDLNotice;</legalnotice>

<!-- Don't change format of date and version of the documentation -->

<date
>2003-08-21</date>
<releaseinfo
>0.8</releaseinfo>

<abstract>
<para
>&konsolekalendar; - это интерфейс командной строки для работы с календарями &kde;</para>
</abstract>


<keywordset>
<keyword
>KDE</keyword>
<keyword
>kdepim</keyword>
<keyword
>konsolekalendar</keyword>
<keyword
>korganizer</keyword>
</keywordset>

</bookinfo>


<chapter id="introduction">
<title
>Введение</title>

<para
>&konsolekalendar; - это интерфейс командной строки для работы с календарями &kde;. Он позволяет просматривать, создавать, удалять и редактировать записи в календаре из командной строки или с помощью языка скриптовых сценариев. Также &konsolekalendar; может экспортировать календарь &kde; в различные форматы.</para>

<para
>В режиме работы по умолчанию &konsolekalendar; выводит список записей на сегодня с 7:00 до 17:00</para>

<para
>Возможности &konsolekalendar; <itemizedlist>
<listitem
><para
>Вывод записей в календаре, начиная с указанной даты/времени и заканчивая указанной датой/временем</para
></listitem>
<listitem
><para
>Добавление записей в календарь</para
></listitem>
<listitem
><para
>Удаление записей</para
></listitem>
<listitem
><para
>Изменение записей</para
></listitem>
<listitem
><para
>Экспорт календарных записей в другие форматы</para
></listitem>
</itemizedlist
></para>

<para
>&konsolekalendar; это <emphasis
>не</emphasis
> очередной графический интерфейс для календаря &kde; (как, например, &korganizer;). &konsolekalendar; предназначен для тех случаев, когда графический интерфейс недоступен.</para>

<para
>&konsolekalendar; не предоставляет полноразмерный язык для создания запросов к календарю, впрочем, это и не является целью авторов. Предоставляются лишь простейшие опции для доступа к календарю из командной строки в пределах заданных времени и даты. </para>

</chapter>

<chapter id="features">
<title
>Дополнительные возможности</title>
<para
>В этой главе вы узнаете о полезных функциях &konsolekalendar;, о ключах командной строки (помните, что &konsolekalendar; - это не графический интерфейс, а программа командной строки).</para>

<para
>Вы также узнаете о добавлении, удалении и редактировании календарных записей,  а также о конвертировании записей в другие форматы.</para>

<sect1 id="viewing">
<title
>Просмотр записей</title>

<para
>В режиме работы по умолчанию, или при использовании ключа <parameter
>--view</parameter
> &konsolekalendar; выведет на экран все записи, соответсвующие заданным времени и дате. </para>

<para
>Вот как можно увидеть все записи, относящиеся к сегодняшнему дню:</para>

<informalexample>
<para
><prompt
>%</prompt
><userinput
> <command
>konsolekalendar</command
> </userinput
> </para>
</informalexample>

<para
>В этом примере мы увидим, как можно вывести все записи, относящиеся к числам с 18 по 22 августа:</para>

<informalexample>
<para
><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
> </userinput
> </para>
</informalexample>

<!-- TODO -->
<!-- <para
>Shows the next event on the calendar from the current time forward:</para
> -->

<!-- <informalexample
> -->
<!-- <para
> -->
<!-- <prompt
>%</prompt
><userinput
> -->
<!-- <command
>konsolekalendar</command
> -->
<!-- <option
>- -next</option
> -->
<!-- </userinput
> -->
<!-- </para
> -->
<!-- </informalexample
> -->

</sect1>

<sect1 id="inserting">
<title
>Добавление записей</title>

<para
>С помощью &konsolekalendar; можно вносить новые записи в календарь &kde;, используя ключ <parameter
>--add</parameter
> командной строки.</para>

<para
>В этом примере мы добавим событие "Поход к врачу", запланированный на 04.06.2003 с 10:00 до 12:00 с пометкой "Поход к врачу" в календарь, используемый по умолчанию:</para>

<informalexample>
<para
><prompt
>%</prompt
><userinput
> <command
>konsolekalendar</command
> <option
>--add</option
> <option
>--date <replaceable
>2003-06-04</replaceable
></option
> <option
>--time <replaceable
>10:00</replaceable
></option
> <option
>--end-time <replaceable
>12:00</replaceable
></option
> <option
>--summary <replaceable
>"Поход к врачу"</replaceable
></option
> </userinput
> </para>
</informalexample>

<para
>В этом примере мы добавим день рождения в календарь пользователя:</para>

<informalexample>
<para
><prompt
>%</prompt
><userinput
> <command
>konsolekalendar</command
> <option
>--add</option
> <option
>--date <replaceable
>2003-06-06</replaceable
></option
> <option
>--summary <replaceable
>"Мой день рождения"</replaceable
></option
> <option
>--description <replaceable
>"Время праздника!"</replaceable
></option
> </userinput
> </para>
</informalexample>

<tip
><para
>TODO: Чтобы добавить день рождения, праздник, юбилей и т.д. в календарь как <emphasis
>свободное</emphasis
>событие (т.е. событие, которое не занимает время днем),  используйте ключ <option
>--time=free</option
> в командной строке. </para>
</tip>

<para
>В этом примере в календарь пользователя вносится выходной:</para>

<informalexample>
<para
><prompt
>%</prompt
><userinput
> <command
>konsolekalendar</command
> <option
>--add</option
> <option
>--date <replaceable
>2003-08-01</replaceable
></option
> <option
>--end-date <replaceable
>2003-08-20</replaceable
></option
> <option
>--summary <replaceable
>"Выходной"</replaceable
></option
> <option
>--description <replaceable
>"Не найдете меня!!!"</replaceable
></option
> </userinput
> </para>
</informalexample>

</sect1>

<sect1 id="deleting">
<title
>Удаление записей</title>

<para
>&konsolekalendar; может удалять записи из календаря &kde;, используя ключ <parameter
>--delete</parameter
> командной строки.</para>

<warning>
<para
>ЭТА ФУНКЦИЯ ЕЩЕ НЕ ТЕСТИРОВАНА! ИСПОЛЬЗУЙТЕ НА СВОЙ СТРАХ И РИСК! </para>
</warning>
</sect1>

<sect1 id="changing">
<title
>Изменение записей </title>

<para
>&konsolekalendar; может изменять существующие записи в календаре &kde;, используя ключ <parameter
>--change</parameter
> в командной строке.</para>

<warning>
<para
>ЭТА ФУНКЦИЯ ЕЩЕ НЕ ТЕСТИРОВАНА! ИСПОЛЬЗУЙТЕ НА СВОЙ СТРАХ И РИСК! </para>
</warning>

</sect1>

<sect1 id="exporting">
<title
>Экспорт в другие форматы</title>

<para
>&konsolekalendar; может экспортировать записи календаря &kde; в другие, широко распространенные форматы, используя ключ <parameter
>--export-type</parameter
> в командной строке.</para>

</sect1>

</chapter>

<chapter id="features-commandline-options">
<title
>Параметры командной строки</title>

<para
>&konsolekalendar; поддерживает следующие ключи командной строки:</para>

<informaltable>
<tgroup cols="3">
<thead>
<row>
  <entry
>Параметры</entry>
  <entry
>Описание:</entry>
  <entry
>Заметки</entry>
</row>
</thead>
<tbody>
<row>
  <entry
><option
>--help</option
></entry>
  <entry
>Показать справку о параметрах программы</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--author</option
></entry>
  <entry
>Показывает информацию об авторе программы.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>-v</option
>, <option
>--version</option
></entry>
  <entry
>Показать окно с краткими сведениями о версии.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--license</option
></entry>
  <entry
>Показать информацию о лицензии.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--verbose</option
></entry>
  <entry
>Показать полезные отладочные сообщения.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--dryrun</option
></entry>
  <entry
>Показывает, что могло бы быть сделано, не изменяя записи, не добавляя и не удаляя записи из календаря. Не изменяются и не создаются новые файлы.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--file</option
> <replaceable
>calendar-file</replaceable
></entry>
  <entry
>Назначает календарь, который вы хотите использовать. <para
>По умолчанию используется календарь korganizer  (Активный календарь указан в <filename
>$<envar
>HOME</envar
>/.kde/share/config/korganizerrc</filename
>)</para
></entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--view</option
></entry>
  <entry
>Вывести календарные записи в указанном формате.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--add</option
></entry>
  <entry
>Добавить запись в календарь.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--change</option
></entry>
  <entry
>Изменить. существующую запись.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--delete</option
></entry>
  <entry
>Удалить существующую запись.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--import</option
> <replaceable
>import-file</replaceable
></entry>
  <entry
>Импорт календаря в основной календарь.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--export-type</option
> <replaceable
>export-type</replaceable
></entry>
  <entry
>Тип файла для экспорта. По умолчанию тип "Текст".</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--export-file</option
> <replaceable
>export-file</replaceable
></entry>
  <entry
>Экспорт в файл. По умолчанию осуществляется на стандартный вывод.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--export-list</option
></entry>
  <entry
>Вывести доступные форматы для экспортирования и выйти.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--next</option
></entry>
  <entry
>Следующая запись в календаре.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--date</option
> <replaceable
>date</replaceable
></entry>
  <entry
>Начать с указанного дня (ГГГГ-ММ-ДД). По умолчанию - сегодня.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--time</option
></entry>
  <entry
>Начать с указанного времени (ЧЧ:ММ). По умолчанию - с 7:00.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--end-date</option
> <replaceable
>end-date</replaceable
></entry>
  <entry
>Закончить вывод указанным днем (ГГГГ-ММ-ДД). День по умолчанию устанавливается <replaceable
>--date</replaceable
>.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--end-time</option
> <replaceable
>end-time</replaceable
></entry>
  <entry
>Закончить вывод на указанном времени (ЧЧ:ММ). По умолчанию - 17:00</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--epoch-start</option
> <replaceable
>epoch-time</replaceable
></entry>
  <entry
>Начать с указанного времени (секунды с момента epoch).</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--epoch-end</option
> <replaceable
>epoch-time</replaceable
></entry>
  <entry
>Закончить на указанном времени (секунд с момента epoch).</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--description</option
> <replaceable
>description</replaceable
></entry>
  <entry
>Добавить описание к записи (работает с add и change).</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--summary</option
> <replaceable
>summary</replaceable
></entry>
  <entry
>Добавить краткое описание к записи (работает с add и change). </entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--all</option
></entry>
  <entry
>Показать все календарные записи.</entry>
  <entry
>N/A</entry>
</row>
<row>
  <entry
><option
>--create</option
></entry>
  <entry
>Создать новый календарь, если он не существует.</entry>
  <entry
>N/A</entry>
</row>
</tbody>
</tgroup>
</informaltable>

</chapter>

<chapter id="faq">
<title
>Вопросы и ответы</title>
&reporting.bugs; &updating.documentation; <qandaset id="faqlist">
<qandaentry>
<question>
<para
>Какие файлы настроек использует &konsolekalendar;?</para>
</question>
<answer>
<para
>Никаких.</para>
</answer>
</qandaentry>


<qandaentry>
<question>
<para
>Какие имена у приложения &konsolekalendar;?</para>
</question>
<answer>
<para
>Название приложения &konsolekalendar; - это <application
> konsolekalendar</application
>.</para>
</answer>
</qandaentry>

</qandaset>
</chapter>


<chapter id="credits">

<title
>Благодарности и лицензия</title>

<para
>&konsolekalendar; </para>
<para
>Права на программу принадлежат Tuukka Pasanencopyright 2002,2003 <email
>illuusio@mailcity.com</email
> </para>
<para
>Авторы-участники: <itemizedlist
> <listitem
><para
>Allen Winter <email
>winterz@earthlink.net</email
></para>
</listitem>
</itemizedlist>
</para>

<para
>Авторские права на документацию 2003 Allen Winter <email
>winterz@earthlink.net</email
> </para>

<para
>Nick <email
>blindguard@mtu-net.ru</email
></para
> 
&underFDL; &underGPL; </chapter>

<appendix id="installation">
<title
>Установка</title>

<sect1 id="getting-konsolekalendar">
<title
>Откуда можно скачать &konsolekalendar;</title>
&install.intro.documentation; <para
>&konsolekalendar; поставляется с &kde;3 и недоступен отдельно. </para>

</sect1>

<sect1 id="requirements">
<title
>Системные требования</title>

<para
>Для сборки и установки вам понадобится пакет <filename
>kdelibs</filename
>. Для компиляции из исходных текстов вам также необходимы Qt и <filename
>kdelibs</filename
> development</para>

<para
>Список изменений - <filename
>ChangeLog</filename
> </para>
</sect1>

<sect1 id="compilation">
<title
>Компиляция и установка</title>

<para
>Если вы не нашли подходящий бинарный пакет, то вам неоходимо собрать &konsolekalendar; из исходных файлов. Скачайте файл <filename
>kdepim-x.x.tar.bz2</filename
>. Распакуйте его командой <userinput
><command
>tar</command
> <option
>xvfj <replaceable
>package.tar.bz2</replaceable
></option
></userinput
> и перейдите в созданный каталог.</para>
&install.compile.documentation; <note
><para
>Если у вас установлено несколько версий &kde; (например &kde;2 и &kde;3), то возможна ошибка в процессе установки &konsolekalendar;. Если необходимо, вы можете задать каталог &kde; как параметр. Например, если &kde; установлен в <filename
>/opt/kde3</filename
>:</para>

<para
><userinput
><command
>./configure</command
> --prefix=<replaceable
>/opt/kde3</replaceable
></userinput
></para>
</note>
</sect1>

<sect1 id="configuration">
<title
>Настройки</title>

<para
>Никакой настройки &konsolekalendar; не требуется.</para>

</sect1>

</appendix>

&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

