diff options
author | Emanoil Kotsev <[email protected]> | 2018-11-12 21:18:37 +0100 |
---|---|---|
committer | Emanoil Kotsev <[email protected]> | 2023-01-14 03:44:08 +0000 |
commit | e274309d9293777aaaecebccaa29a339a05bd4f9 (patch) | |
tree | a00349c31b90cdedaa6e351dfe93950b55903dce /doc/en | |
parent | 63c233987977aa48b701edeb47079a6153359fbe (diff) | |
download | tdebluez-e274309d9293777aaaecebccaa29a339a05bd4f9.tar.gz tdebluez-e274309d9293777aaaecebccaa29a339a05bd4f9.zip |
Based on KDE3 bluez4 version a TDE bluez5 version was created
Signed-off-by: Emanoil Kotsev <[email protected]>
Diffstat (limited to 'doc/en')
-rw-r--r-- | doc/en/CMakeLists.txt | 16 | ||||
-rw-r--r-- | doc/en/bemused.docbook | 10 | ||||
-rw-r--r-- | doc/en/components.docbook | 15 | ||||
-rw-r--r-- | doc/en/concepts.docbook | 85 | ||||
-rw-r--r-- | doc/en/credits.docbook | 55 | ||||
-rw-r--r-- | doc/en/developers.docbook | 25 | ||||
-rw-r--r-- | doc/en/download.docbook | 16 | ||||
-rw-r--r-- | doc/en/faq.docbook | 21 | ||||
-rw-r--r-- | doc/en/handsfree.docbook | 15 | ||||
-rw-r--r-- | doc/en/index.docbook | 164 | ||||
-rw-r--r-- | doc/en/installation.docbook | 77 | ||||
-rw-r--r-- | doc/en/introduction.docbook | 24 | ||||
-rw-r--r-- | doc/en/irmcsynckonnector.docbook | 109 | ||||
-rw-r--r-- | doc/en/kbluelock.docbook | 10 | ||||
-rw-r--r-- | doc/en/kbtobexsrv.docbook | 49 | ||||
-rw-r--r-- | doc/en/kbtserialchat.docbook | 44 | ||||
-rw-r--r-- | doc/en/khciconfig.docbook | 10 | ||||
-rw-r--r-- | doc/en/links.docbook | 27 | ||||
-rw-r--r-- | doc/en/news.docbook | 4 | ||||
-rw-r--r-- | doc/en/othertools.docbook | 31 | ||||
-rw-r--r-- | doc/en/tdebluez.docbook | 53 | ||||
-rw-r--r-- | doc/en/tdeio_bluetooth.docbook | 41 | ||||
-rw-r--r-- | doc/en/tdeio_obex.docbook | 61 | ||||
-rw-r--r-- | doc/en/tdeioclient.docbook | 8 |
24 files changed, 970 insertions, 0 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt new file mode 100644 index 0000000..9456e01 --- /dev/null +++ b/doc/en/CMakeLists.txt @@ -0,0 +1,16 @@ +################################################# +# +# (C) 2018 Emanoil Kotsev +# deloptes (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# +#KDE_LANG = en +#KDE_DOCS = kdebluetooth + +tde_create_handbook( DESTINATION tdebluez ) + +#tde_create_handbook( LANG de DESTINATION tdebluez )
\ No newline at end of file diff --git a/doc/en/bemused.docbook b/doc/en/bemused.docbook new file mode 100644 index 0000000..0e968c9 --- /dev/null +++ b/doc/en/bemused.docbook @@ -0,0 +1,10 @@ +<sect1 id="components.bemused"> +<title>Bemused Server: Control your media player with your phone</title> +<para> +The KDE documentation for this component is still being developed. Meanwhile, please visit the <ulink url="http://bemused.sourceforge.net/">Bemused homepage</ulink> for more information. +</para> +<para> +If you have any questions about it or if you want to complain about the missing documentation, send email to <link linkend="credits.ai">Alex Ibrado</link>. +</para> +</sect1> + diff --git a/doc/en/components.docbook b/doc/en/components.docbook new file mode 100644 index 0000000..5df0061 --- /dev/null +++ b/doc/en/components.docbook @@ -0,0 +1,15 @@ +<chapter id="components"> +<title>Components</title> +&components.tdebluez; +&components.tdeio_bluetooth; +&components.tdeio_obex; +&components.tdeioclient; +<!--&components.kbtobexsrv;--> +<!--&components.bemused;--> +<!--&components.kbluelock;--> +<!--&components.khciconfig;--> +&components.handsfree; +<!--&components.kbtserialchat;--> +<!--&components.irmcsynckonnector;--> +<!--&components.othertools;--> +</chapter> diff --git a/doc/en/concepts.docbook b/doc/en/concepts.docbook new file mode 100644 index 0000000..a0f2bf7 --- /dev/null +++ b/doc/en/concepts.docbook @@ -0,0 +1,85 @@ +<chapter id="concepts"> +<title>Concepts</title> + +<sect1 id="concepts.pairing"> +<title>Bluetooth security: Pairing devices</title> + +<sect2 id="concepts.pairing.whatisit"> +<title>What is "Pairing"?</title> +<para> +Very often it is required for a device to authenticate iself when it +wants to access a service. In that case the two devices needs to be +<phrase>paired</phrase>. +When two devices are paired, they can be sure about the identity of the other +party. Without pairing, you would have to rely on the address or name of +the other device, which can be faked easily. +</para> +<para> +Pairing usually happens one time between two devices. After pairing, connections +between the two devices will be <phrase>authenticated</phrase> automatically. +</para> +<para> +Usually <emphasis>the pairing process will be started automatically when it is needed</emphasis>. +You do not have to worry about a device not being paired if you want to access its services. +If they try to authenticate, but fail, the pairing process will be started automatically. +</para> +</sect2> + +<sect2 id="concepts.pairing.howdoesitwork"> +<title>How does it work?</title> + +<para> +Devices are paired to be sure about the identity of the other side. But the +first step can't be done automatically. <emphasis>You</emphasis> have to make +sure that you know who wants to pair with your device. This is done by entering +a "PIN" number in both devices. The notion "PIN" is widely used, but misleading. +It is not the type of PIN you have to enter to get money from a cash machine. +You don't have to remember it. And after (!) the pairing is done you don't have to +keep it secret. You only have to make sure that nobody else knows that number +until you (or you two) entered this number in each device. +</para> +<para> +To be on the safe side, you should not only keep the PIN secret during the pairing +process, but you should also use a random number, which can't be guessed easily. +TDE Bluetooth assists you here by creating a 8-digit random number itself if possible. +You can also use characters for a pin, but then you might have problems entering +it into the pin dialog on a mobile phone. +</para> +</sect2> + +<sect2 id="concepts.pairing.pinhelper"> +<title>The PIN helper</title> +<para> +But where should the pin be entered? As it was noted before, the devices will simply +ask you for the PIN when is is needed. For BlueZ, things are a bit more complicated. +There are several ways for BlueZ to get the PIN number from the user. +</para> +<para> +TDE Bluetooth makes it simple by offering Authentication Agent that interacts with the +bluetooth subsystem and offers dialogs to confirm or fill in PIN. +Please see the <link linkend="installation.setup">setup instructions</link> on how to set +up the pin helper and what to do if it doesn't work. +</para> +</sect2> + +<sect2 id="concepts.pairing.bluez"> +<title>Managing paried devices</title> +<para> +After you have paired many devices you might ask yourself which devices are paired and which one not. You also may want to remove a pairing. +</para> +<para> +First, no device can ever know for sure with which devices it is paired. When two devices are paired, they share a secret <phrase>link key</phrase>, which was created during the paring process based on the pin number and some other ingredients. Because the other side may decide to delete a link key without notice, haveing a link key for a given device doesn't guarantee that the link key on the other side still exists. If one link key is gone, the pairing does not exist anymore. Of course you can be sure that you are <emphasis>not</emphasis> paired with a device if you don't have a link key for it. +</para> +<para> +So how can link keys be removed? That depends on the device. Most phones or PDAs have a list of "paired" or "trusted" devices, where you can remove single item from somehow. +In TDE Bluez you can remove the device by using the "Devices..." and then select and delete the device. +</para> +<para> +There is as special annoyance involved, when you frequently switch between different operating system which both use bluetooth (Linux<->Windows usually): When you pair your phone under Linux and then boot Windows, Windows will know nothing about the link keys managed by Bluez. So it appears as if the computer has dropped the link key and you will have to pair again. Depending on your device it might not even be possible to pair again without removing the "old" link key on the device before. +</para> + +</sect2> + +</sect1> + +</chapter> diff --git a/doc/en/credits.docbook b/doc/en/credits.docbook new file mode 100644 index 0000000..24e91a6 --- /dev/null +++ b/doc/en/credits.docbook @@ -0,0 +1,55 @@ +<appendix id="credits"> +<!-- Include credits for the programmers, documentation writers, and +contributors here. The license for your software should then be included below +the credits with a reference to the appropriate license file included in the KDE +distribution. --> +<title>Credits and License</title> + +<para> +&The.framework; +</para> +<para> +Program copyright 2003,2004,2020 &The.framework; team +</para> +<para> +Team Members: +<variablelist> + +<varlistentry id="credits.fs"> +<term> +Fred Schättgen <email>[email protected]</email> +</term> +<listitem> + +<itemizedlist> +<listitem><para>kbluetoothd</para></listitem> +<listitem><para>tdeio_bluetooth</para></listitem> +<listitem><para>tdeio_sdp</para></listitem> +<listitem><para>kbtserialchat</para></listitem> +<listitem><para>kbthandsfree (disabled in 1.0)</para></listitem> +<listitem><para>kcm_kbluetoothd</para></listitem> +<listitem><para>bemused server</para></listitem> +<listitem><para>libkbluetooth</para></listitem> +<listitem><para>kioclient</para></listitem> +<listitem><para>kbtsearch</para></listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +</variablelist> +</para> +<para> +Documentation Copyright © 2004 Fred Schättgen <email>[email protected]</email> +</para> +<para> +Documentation Copyright © 2020 &Emanoil.Kotsev; <email>&Emanoil.Kotsev.mail;</email> +</para> + + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> +&underGPL; <!-- GPL License --> + +</appendix> diff --git a/doc/en/developers.docbook b/doc/en/developers.docbook new file mode 100644 index 0000000..31a5d65 --- /dev/null +++ b/doc/en/developers.docbook @@ -0,0 +1,25 @@ +<chapter id="developers"> +<title>Developer Information</title> + +<sect1 id="developers.tdebluez"> +<title>TDEBluetooth</title> +<para>This section describes how to utilize tdebluez for your own application or access it from scripts to retrieve cached device names or similar. +</para> + +<sect2> +<title>The tdebluez library</title> +<para> +The library provides access to the implementation of the DBus interfaces specified in <ulink url="https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc">the kernel documentation</ulink>. +</para> +</sect2> + +<sect2> +<title>The tdeobex library</title> +<para> +The library provides access to the implementation of the DBus interfaces specified in the kernel documentation <ulink url="https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc">the kernel documentation</ulink>. +</para> +</sect2> + +</sect1> +</chapter> + diff --git a/doc/en/download.docbook b/doc/en/download.docbook new file mode 100644 index 0000000..719aff7 --- /dev/null +++ b/doc/en/download.docbook @@ -0,0 +1,16 @@ +<chapter id="download"> +<title>Getting &the.framework;</title> +<sect1 id="download.tarballs"> +<title>Sources</title> +<para> +&The.framework; is part of <ulink url="https://www.trinitydesktop.org/">TDE - the Trinity Desktop Environment</ulink>. +You can download and compile the the sources yourself, but we recommend using a package for your distribution. +</para> + +<para> +Or you find the source code in <ulink url="https://mirror.git.trinitydesktop.org/gitea/">the git repository</ulink>. +</para> + +</sect1> + +</chapter> diff --git a/doc/en/faq.docbook b/doc/en/faq.docbook new file mode 100644 index 0000000..e60263f --- /dev/null +++ b/doc/en/faq.docbook @@ -0,0 +1,21 @@ +<chapter id="faq"> +<title>Questions and Answers</title> +<qandaset defaultlabel="qanda"> + +<qandaentry> +<question> +<para>My problem isn't listed in this FAQ. Where else can I get help?</para> +</question> +<answer> +<para>You can ask on +<ulink url="https://mirror.git.trinitydesktop.org/gitea/">Gitea</ulink> +where you can post your questions and comments or on +gmane.comp.desktop.trinity.devel. +Please look in the archive first before posting, but don't hesitate to ask +us if you didn't find anything helpful.</para> +</answer> +</qandaentry> + +</qandaset> + +</chapter> diff --git a/doc/en/handsfree.docbook b/doc/en/handsfree.docbook new file mode 100644 index 0000000..0b6e48f --- /dev/null +++ b/doc/en/handsfree.docbook @@ -0,0 +1,15 @@ +<sect1 id="components.handsfree"> +<title>Dial and talk using your computer</title> +<para> +The handsfree client is an implementation of the Bluetooth handsfree profile. +This protocol is similar to the headset profile, but it provides more +functions than the older headset profile. Originally, the handsfree profile +was designed for use in car handsfree devices, but more and more common +Bluetooth headset support the profile today. + +Modern linux provide ofono as modem manager. For the moment it is possible to +connect the HFP and use external ofono frontends for managing calls. +</para> + +</sect1> + diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..de24b01 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,164 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY The.framework "<application>The TDE Bluetooth framework</application>"> + <!ENTITY the.framework "<application>the TDE Bluetooth framework</application>"> + <!ENTITY kde "<acronym>TDE</acronym>"> + <!ENTITY kappname "&The.framework;"> + <!ENTITY package "tdebluez"> + <!ENTITY Fred.Schaettgen "<firstname>Fred</firstname><surname>Schättgen</surname>"> + <!ENTITY Fred.Schaettgen.mail "<email>[email protected]</email>"> + <!ENTITY Emanoil.Kotsev "<firstname>Emanoil</firstname><surname>Kotsev</surname>"> + <!ENTITY Emanoil.Kotsev.mail "<email>[email protected]</email>"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> + + + <!ENTITY faq SYSTEM "faq.docbook"> + <!ENTITY download SYSTEM "download.docbook"> + <!ENTITY installation SYSTEM "installation.docbook"> + <!ENTITY introduction SYSTEM "introduction.docbook"> + <!ENTITY concepts SYSTEM "concepts.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> + <!ENTITY links SYSTEM "links.docbook"> + <!ENTITY news SYSTEM "news.docbook"> + <!ENTITY components SYSTEM "components.docbook"> + <!ENTITY developers SYSTEM "developers.docbook"> + + <!ENTITY components.handsfree SYSTEM "handsfree.docbook"> + <!ENTITY components.tdebluez SYSTEM "tdebluez.docbook"> + <!ENTITY components.tdeio_obex SYSTEM "tdeio_obex.docbook"> + <!ENTITY components.tdeio_bluetooth SYSTEM "tdeio_bluetooth.docbook"> + <!ENTITY components.tdeioclient SYSTEM "tdeioclient.docbook"> + <!--<!ENTITY components.kbtobexsrv SYSTEM "kbtobexsrv.docbook">--> + <!--<!ENTITY components.kbtserialchat SYSTEM "kbtserialchat.docbook">--> + <!--<!ENTITY components.tdeio_sdp SYSTEM "tdeio_sdp.docbook">--> + <!--<!ENTITY components.bemused SYSTEM "bemused.docbook">--> + <!-- khciconfig is currently disabled because it's unmaintained --> + <!--<!ENTITY components.khciconfig SYSTEM "khciconfig.docbook">--> + <!--<!ENTITY components.kbtobexclient SYSTEM "kbtobexclient.docbook">--> + <!--<!ENTITY components.kbluelock SYSTEM "kbluelock.docbook">--> + <!--<!ENTITY components.irmcsynckonnector SYSTEM "irmcsynckonnector.docbook">--> + <!--<!ENTITY components.othertools SYSTEM "othertools.docbook">--> + + <!-- Do not define any other entities; instead, use the entities + from entities/general.entities and $LANG/user.entities. --> +]> +<!-- kdoctemplate v0.9 January 10 2003 + Changes to comments to clarify entity usage January 10 2003 + Minor update to "Credits and Licenses" section on August 24, 2000 + Removed "Revision history" section on 22 January 2001 + Changed to Installation/Help menu entities 18 October 2001 + Other minor cleanup and changes 18 October 2001 + FPI change and minor changes November 2002 --> + +<book lang="&language;"> + +<!-- This header contains all of the meta-information for the document such +as Authors, publish date, the abstract, and Keywords --> + +<bookinfo> +<title>&The.framework; Handbook</title> + +<authorgroup> + +<author> +&Fred.Schaettgen; +<affiliation> +<address><email>[email protected]</email></address> +</affiliation> +</author> + +<author> +&Emanoil.Kotsev; +<affiliation> +<address><email>&Emanoil.Kotsev.mail;</email></address> +</affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2004</year> +<holder>&Fred.Schaettgen;</holder> +</copyright> + +<copyright> +<year>2020</year> +<holder>&Emanoil.Kotsev;</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook + and in the FDL itself on how to use it. --> +<legalnotice>&FDLNotice;</legalnotice> + +<!-- Date and version information of the documentation +Don't forget to include this last date and this last revision number, we +need them for translation coordination ! +Please respect the format of the date (YYYY-MM-DD) and of the version +(V.MM.LL), it could be used by automation scripts. +Do NOT change these in the translation. --> + +<date>2020-07-27</date> +<releaseinfo>1.0</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +This is an overview over the TDE Bluetooth Framework. The framework +is a package of several tools and infrastruture for TDE, which are +usually used to communicate with bluetooth devices such as mobile phones +or PDAs. It is built on top of BlueZ 5, the official Bluetooth stack for Linux. +</para> +</abstract> + +<!-- This is a set of Keywords for indexing by search engines. +Please at least include KDE, the KDE package it is in, the name + of your application, and a few relevant keywords. --> + +<keywordset> +<keyword>TDE</keyword> +<keyword>tdenetwork</keyword> +<keyword>tdebluez</keyword> +<keyword>Bluetooth</keyword> +<keyword>Rfcomm</keyword> +<keyword>BlueZ</keyword> +<keyword>OBEX</keyword> +<keyword>Sync</keyword> +</keywordset> + +</bookinfo> + +<!-- The contents of the documentation begin here. Label +each chapter so with the id attribute. This is necessary for two reasons: it +allows you to easily reference the chapter from other chapters of your +document, and if there is no ID, the name of the generated HTML files will vary +from time to time making it hard to manage for maintainers and for the SVN +system. Any chapter labelled (OPTIONAL) may be left out at the author's +discretion. Other chapters should not be left out in order to maintain a +consistent documentation style across all KDE apps. --> + +&introduction; + +&news; + +&download; + +&installation; + +&components; + +&concepts; + +&faq; + +&developers; + +&links; + +&credits; + +&documentation.index; + +</book> diff --git a/doc/en/installation.docbook b/doc/en/installation.docbook new file mode 100644 index 0000000..4df17a1 --- /dev/null +++ b/doc/en/installation.docbook @@ -0,0 +1,77 @@ +<chapter id="installation"> +<title>Installation</title> + +<sect1 id="installation.requirements"> +<title>Requirements</title> +<para> +Dependencies: +</para> +<itemizedlist> +<listitem><para> +TDE >=14.0.9 +</para></listitem> +<listitem><para> +Openobex >=1.5 +</para></listitem> +<listitem><para> +TQt >=14.0.9 +</para></listitem> +<listitem><para> +bluez5 >=5.14 +</para></listitem> +</itemizedlist> +<!--<para>For the handsfree client you will also need ofono and pulseaudio.</para>--> +</sect1> + + +<sect1 id="installation.compilation"> +<title>Compilation and Installation</title> +<para> +Create build directory and "cd build". +</para> +<para> +Run cmake .. +</para> +<para> +make install +</para> +</sect1> + + +<sect1 id="installation.setup"> +<title>Setup</title> +<para> +The TDE Bluetooth Framework itself does not need any setup. +</para> + +<para> +Use hciconfig and sdptool to check low level if needed: +</para> +<screen> +root:~# hciconfig <- Check if adaptor was found and is up +hci0: Type: USB + BD Address: 00:10:60:A3:8B:DE ACL MTU: 192:8 SCO MTU: 64:8 + UP RUNNING PSCAN ISCAN AUTH ENCRYPT + RX bytes:176023 acl:2046 sco:0 events:1809 errors:0 + TX bytes:23000 acl:971 sco:0 commands:469 errors:0 + +root:~# hcitool inq <- Try to seach for other discoverable devices +Intquiring ... + 00:A0:32:1A:B0:27 clock offset: 0x122b class: 0x000100 + +root:~# sdptool browse FF:FF:FF:00:00:00 +Browsing FF:FF:FF:00:00:00 ... +Service Name: SDP Server +Service Description: Bluetooth service discovery server +Service Provider: BlueZ +Service RecHandle: 0x0 +... +root:~# +</screen> +<para> +The first command checks if your bluetooth device is up, the second searches for +other devices in range (they must be set to be discoverable). The last command lists the services that are offered by you to other bluetooth devices. If you have tdebluez running already, you will get the full list of active services here, including obex push etc. If that succeeds you should be able to use tdebluez without any further setup. +</para> +</sect1> + +</chapter> diff --git a/doc/en/introduction.docbook b/doc/en/introduction.docbook new file mode 100644 index 0000000..04aa88d --- /dev/null +++ b/doc/en/introduction.docbook @@ -0,0 +1,24 @@ +<chapter id="introduction"> +<title>Introduction</title> + +<!-- The introduction chapter contains a brief introduction for the +application that explains what it does and where to report +problems. Basically a long version of the abstract. Don't include a +revision history. (see installation appendix comment) --> + +<para> +The TDE Bluetooth Framework is a set of tools built on top of Linux' +Bluetooth stack <ulink url="http://www.bluez.org">BlueZ</ulink>. Our goal +is to provide easy access to the most common Bluetooth profiles and to make +data exchange with Bluetooth enabled phones and PDAs as straightforward as +possible. +</para> +<para> +The next chapters will explain how to set up tdebluez as a whole; the +following chapters deal with each of the tools, how to use them and how +to set up each of them. +</para> +<para> +Have fun :] +</para> +</chapter> diff --git a/doc/en/irmcsynckonnector.docbook b/doc/en/irmcsynckonnector.docbook new file mode 100644 index 0000000..c295b70 --- /dev/null +++ b/doc/en/irmcsynckonnector.docbook @@ -0,0 +1,109 @@ +<sect1 id="components.irmcsynckonnector"> +<title>IrMCSync Konnector for Kitchensync</title> +<para> +This program is a Konnector plugin for kitchensync, it let you sync your device supporting IrMCSync with your local Calendar and/or AddressBook. +</para> +<para> +By now Calendar and AddressBook are supported! +</para> +<para> +I SUGGEST YOU TO MAKE A COPY OF YOUR CALENDAR AND ADDRESSBOOK BEFORE TRYING ANY SYNC. +I'm not responsible if your data will be corrupted or destroyed. +</para> + + +<sect2> +<title>We need debug infos!</title> +<para> +PLEASE run kitchensync from a shell or redirect stdout and stderr to a file so if you have problems you can send me the konnector output.To enable the debug features you can launch "kdebugdialog" and set on the kitchensync related options (from 5200) and the generic option. +</para> +</sect2> + +<sect2> +<title>Compilation.</title> +<para> +The actuall kitchensync from tdepim SVN has more features and work better than the tdepim 3.3.0 version. +I'll suggest to use this version. You have to install at least kitchensync (and all his subprojects) from SVN. +</para> +<para> +There's also a tdepim-3.3.0 version that you can find in the irmcsync_tdepim_3_3_branch but it's not mantained anymore. I'll concentrate my work on the SVN one. +This version depends on tdepim-3.3.0 and the older or younger versions, so you have to get and install it. +If you want to fetch the irmcsync_tdepim_3_3_branch you have to move to +kdebluetooth/irmcsync/irmcsynckonnector and type: + +cvs -f -z3 -q update -d -P -r irmcsync_tdepim_3_3_branch +</para> + +<para> +To enable the compilation of the konnector you have to add the "irmcsync" dir in the SUBDIR variabile of kdebluetooth/Makefile.am +</para> +</sect2> + +<sect2> +<title>Using KitchenSync.</title> +<para> +In these days (25/03/2004) KitchenSync is very experimental so you can get various problems. +</para> +<para> +After having launched it, you have to choose the konnectors to use. +you need at least 2 konnector to make a sync, but you can use only one for tests pourpose. +</para> +<para> +To add a konnector go in <guimenuitem>Settings->Configure Kitchensync</guimenuitem> +</para> +<para> +If you get some errors and the widget is now well painted try resizing the configure window. Then in the Resources Combobox you'll get various chooses, ALL ARE UNUSEFUL AND DISABLED, only "konnector" is the right. +</para> +<para> +For Example you can add the IrMCSync Konnector and a Local Konnector. +</para> +<para> +In the IrMCSync Konnector select your device, and check the Sync Calendar CheckButton or the AddressBook (for now you can't sync both at the same time). In the Local Konnector Select a Calendar File AND a KAddressBook file (you have to choose both and with right filenames or it will not work). I suggest you to create a temp directory in which you put a copy of you original AB and Calendar so you can make some tests. +</para> +<para> +You can find them usually in these dirs: +</para> +<para> +CALENDAR: <filename>$HOME/.kde/share/apps/korganizer/std.ics</filename> +</para> +<para> +ADDRESSBOOK: <filename>$HOME/.kde/share/apps/tdeabc/std.vcf</filename> +</para> +<para> +Then you have to create a profile in <guimenuitem>Settings->Configure Profiles</guimenuitem> and for every profile you can add various parts, every part do a different function: +</para> +<itemizedlist> +<listitem> +<para> +Synchronize Part : Make the REAL Sync. +</para> +</listitem> +<listitem> +<para> +Konnector Debugger: Let you Debug a Konnector. +</para> +</listitem> +<listitem> +<para> +Konnector Backup : Make the backup of the data. +</para> +</listitem> +<listitem> +<para> +Overview Part : Like the name says. +</para> +</listitem> +</itemizedlist> + +<para> +If you want to sync, you have to choose at least the "Synchronize Part". +</para> +<para> +Then, to make the sync, click on the top-left button. +</para> +<para> +You can check the konnector, creating a profile with the Konnector Debugger Part and pressing the Connect Device, then the ReadSyncees button. +</para> +</sect2> +</sect1> + diff --git a/doc/en/kbluelock.docbook b/doc/en/kbluelock.docbook new file mode 100644 index 0000000..9150a51 --- /dev/null +++ b/doc/en/kbluelock.docbook @@ -0,0 +1,10 @@ +<sect1 id="components.kbluelock"> +<title>Automatic screen unlocker</title> +<para> +There is no documentation for this component. +</para> +<para> +If you have any questions about it or if you want to complain about the missing documentation, send a mail to <link linkend="credits.mm">Mattia Merzi</link>. +</para> +</sect1> + diff --git a/doc/en/kbtobexsrv.docbook b/doc/en/kbtobexsrv.docbook new file mode 100644 index 0000000..629c7f5 --- /dev/null +++ b/doc/en/kbtobexsrv.docbook @@ -0,0 +1,49 @@ +<sect1 id="components.kbtobexsrv"> +<title>OBEX Push Server: Receive files</title> +<para> +Most Bluetooth-enabled cell phones or PDAs will let you send +files from the mobile to your computer. While it might be more +comfortable to use the <link linkend="components.tdeio_obex">OBEX FTP tdeioslave</link> +to pull the files from your phone to your computer, not all devices +support this. OBEX Object push on the other hand is supported by most +Bluetooth devices. +</para> + +<sect2> +<title>Using the OBEX Push server</title> +<para> +The OBEX Push server is managed by kbluetoothd and will be automatically +started if it is enabled and someone tries to send you some files. +Please see the documentation of kbluetoothd for how to +<link linkend="components.kbluetoothd.serviceconfig">enable or disable +services</link> (The OBEX Push server is listed as <command>kbtobexsrv</command>). +</para> +<para> +When you send a file from your mobile to your computer, the kbluetoothd +tray icon will turn blue and shows a small popup. By default (depending +on your <link linkend="components.kbluetoothd.confirmation"> +settings for incoming connections</link>) you will have to accept the +connection first, then the main OBEX Push window should pop up +and start receiving the files. +</para> +<para> +Incoming files are saved to <filename>/tmp</filename> and will be deleted +after you closed the OBEX Push server. To save to files, you have two options: +</para> +<itemizedlist> +<listitem> +<para>Click <guibutton>OK</guibutton> to save all received files to +a predefined location.</para> +</listitem> +<listitem> +<para> +Drag one or several files to some other location. This is especially useful +if you want to send files by email, since you can drag the files +directly into kmail without saving them to temporary location first. +</para> +</listitem> +</itemizedlist> +</sect2> + +</sect1> + diff --git a/doc/en/kbtserialchat.docbook b/doc/en/kbtserialchat.docbook new file mode 100644 index 0000000..9f1c4a6 --- /dev/null +++ b/doc/en/kbtserialchat.docbook @@ -0,0 +1,44 @@ +<sect1 id="components.kbtserialchat"> +<title>kbtserialchat: A very simple chat tool</title> +<para> +The kbtserialchat tool is a very simple chat client&server. +Its primary purpose is for debugging and to serve as an example on how to +write a bluetooth server that is managed by kbluetoothd +and how to write a client that can be started with the +<link linkend="components.tdeio_sdp">SDP tdeioslave</link>. +</para> + +<sect2> +<title>Using the chat tool</title> +<para> +kbtserialchat implements the Serial Port protocol, +so when you start it, it will show you all devices which +provide the Serial Port profile. This will include other computers +where the KDE Bluetooth Framework is installed, but also +phones which support this profile. +</para> +<para> +When you are connecting to another kbtserialchat server, then +kbtserialchat will pop up on the other system and you +can happily send each other stupid text messages. +You can also connect to the serial port of Bluetooth phones +and send arbitrary AT-commands. To dial a number for instance, type +<command>ATD<number>;</command>. +</para> +<para> +While it may not make much sense to connect kbtserialchat to +a serial port of a device that uses it to exchange binary +data, you can use it not only to connect to serial port services, but +to every service that's based on Rfcomm, like the handsfree or headset +profile. Since these services are not listed in the dialog on startup, +you can use the following trick: +Browse the services of a device with tdeio_sdp (using a <ulink url="sdp:/">sdp:/</ulink>-URL). +Then instead of simply clicking on the service, right-click on it and +then select <guimenuitem>Open with...</guimenuitem>. +Enter <command>kbtserialchat</command> in the dialog, press enter - and +you're connected. +</para> +</sect2> + +</sect1> + diff --git a/doc/en/khciconfig.docbook b/doc/en/khciconfig.docbook new file mode 100644 index 0000000..7956335 --- /dev/null +++ b/doc/en/khciconfig.docbook @@ -0,0 +1,10 @@ +<sect1 id="components.khciconfig"> +<title>khciconfig: Explore your Bluetooth configuration</title> +<para> +There is no documentation for this component. +</para> +<para> +If you have any questions about it or if you want to complain about the missing documentation, send a mail to <link linkend="credits.mm">Mattia Merzi</link>. +</para> +</sect1> + diff --git a/doc/en/links.docbook b/doc/en/links.docbook new file mode 100644 index 0000000..f1f0eb5 --- /dev/null +++ b/doc/en/links.docbook @@ -0,0 +1,27 @@ +<appendix id="links"> +<title>Links</title> + +<para> +<variablelist> +<title>Other projects and documentation</title> + +<varlistentry> +<term><ulink url="http://www.bluez.org">BlueZ</ulink></term> +<listitem><para>This is the official Bluetooth Stack for Linux +and the base for tdebluez. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc/">Linux BlueZ API</ulink></term> +<listitem><para>This is the official Linux API and the base for the dbus implementation. +</para> + <para>The implementation is done by using dbusxml2qt3 to generate the interfaces. +</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +</appendix> diff --git a/doc/en/news.docbook b/doc/en/news.docbook new file mode 100644 index 0000000..f5b3351 --- /dev/null +++ b/doc/en/news.docbook @@ -0,0 +1,4 @@ +<chapter id="news"> +<title>News</title> +<para></para> +</chapter>
\ No newline at end of file diff --git a/doc/en/othertools.docbook b/doc/en/othertools.docbook new file mode 100644 index 0000000..526c3eb --- /dev/null +++ b/doc/en/othertools.docbook @@ -0,0 +1,31 @@ +<sect1 id="components.othertools"> +<title>Additional Integration- and Command Line Tools</title> +<para> +This sections lists all the other smaller tools and script that come +with tdebluez. Most of them are of limited use alone, but supposed +to be called from within scripts or by other programs. +</para> + +<sect2 id="components.othertools.tdeioclient"> +<title>tdeioclient: Access to the TDEIO OBEX framework</title> +<para> +This is a little utility to access tdeioslaves from the command line. +So <command>tdeioclient</command> is actually a general purpose utility. +</para> +<para> +With <command>tdeioclient</command> you can copy, list, delete any +file or directory which is accessible by TDE's TDEIO Framework. You can +copy a file from a FTP server directly to another server using WebDAV +or list a directory via SSH with tdeio_fish. Or - and that's where it +becomes interesting for us - you can access files on your mobile phone +via tdeio_obex. +</para> +<para> +Please note that tdeioclient - even though it is a command line program - still needs to be + run from within KDE, so you won't be able to use it in cronjobs for instance. +</para> + +</sect2> + +</sect1> + diff --git a/doc/en/tdebluez.docbook b/doc/en/tdebluez.docbook new file mode 100644 index 0000000..fcb849c --- /dev/null +++ b/doc/en/tdebluez.docbook @@ -0,0 +1,53 @@ +<sect1 id="components.tdebluez"> +<title>tdebluez: The Core of the TDE Bluetooth Framework</title> +<para> +TDEBluetooth is a central piece of the TDE Bluetooth framework. It runs all the time in the system tray usually and starts other services like the OBEX Server or +the authentication agent. Its system tray icon tells you about ongoing bluetooth connections and +also gives you quick access to the service configuration, recently used services, devices in range +and more. +</para> +<para> +Programmers who want to integrate their program with tdebluez, should take a look at the <link linkend="developers.tdebluez">developers section</link> for more information. +</para> + +<sect2> +<title>Starting tdebluez</title> +<para> +You can start TDEBluetooth by typing <command>tdebluez</command> on +the command line or by starting it from the TDE-Menu (usually System/tdebluez). +</para> + +<para> +TDEBluetooth displays and icon in the system tray. +</para> + +<para>When tdebluez is running until the system is shut down, it will be started again automatically next time you log in. To keep tdebluez from starting up automatically, uncheck the "Auto Start" option in the configuration.</para> +<para> +</para> +</sect2> + +<sect2> +<title>What tdebluez does</title> +<para> +The goal of tdebluez is to provide user interface and interoperability to the Trinity Desktop Envitonment. The user is able to perform bluetooth related operations such as power on/off, discover, pair and connect varios bluetooth devices. +</para> +</sect2> + +<sect2 id="components.tdebluez.configuration"> +<title>Configuring tdebluez</title> +<para> +tdebluez writes its configuration in <filename>~/.trinity/share/config/tdebluezrc</filename> +<guimenuitem>Configuration-></guimenuitem> +</para> + +<sect3 id="components.tdebluez.profiles"> +<title>Local Services</title> +<para> +Services can be enabled and disabled in <guimenuitem>Configuration-></guimenuitem> +</para> +</sect3> + +</sect2> + +</sect1> + diff --git a/doc/en/tdeio_bluetooth.docbook b/doc/en/tdeio_bluetooth.docbook new file mode 100644 index 0000000..0a3d7cf --- /dev/null +++ b/doc/en/tdeio_bluetooth.docbook @@ -0,0 +1,41 @@ +<sect1 id="components.tdeio_bluetooth"> +<title>Bluetooth-tdeioslaves: Devices and services</title> +<para> +The bluetooth-tdeioslaves let you handle bluetooth devices and +list and use their services with konqueror (or any other file manager that can +use TDE's File IO framework). +</para> +<sect2> +<title>Using the Bluetooth tdeioslves</title> +<para>To search for devices, simply enter +<ulink url="bluetooth:/">bluetooth:/</ulink> with konqueror. You will immediately +see an entry for your own system. +</para> +<para> +You can also click the Bluetooth-Icon in the konqueror sidebar in +the "Services"-tab, next to the LAN- and Audio-CD-Browser. +If you can't see the icon it might help to reset the sidebar +with <guimenuitem>config-button -> Add new -> Rollback to system default</guimenuitem> +</para> +<para> +The devices must have been detected and paired, so that the slaves can communicate with them. +</para> +<para> +When you select a device you will get a listing of the services +published by the device. If the service is supported by tdebluez, +you can click it to launch the appropriate application. +Unless you've disabled it, konqueror will pop up the common file-open-dialog. +In case the service is not known, you will get an open-with-dialog instead. +</para> +</sect2> + +<sect2> +<title>Current limitations</title> +<para>tdeio_bluetooth has no support for nested browse groups currently. This won't +be hard to add, but wasn't need so far.</para> +<para> +You can not connect to services of your own system. +</para> +</sect2> + +</sect1> diff --git a/doc/en/tdeio_obex.docbook b/doc/en/tdeio_obex.docbook new file mode 100644 index 0000000..c58a299 --- /dev/null +++ b/doc/en/tdeio_obex.docbook @@ -0,0 +1,61 @@ +<sect1 id="components.tdeio_obex"> + <title>OBEX-tdeioslave: Browse folders over Bluetooth</title> + + <sect2> + <title>General</title> + <para>The OBEX protocol is designed for use with mobile devices. If you have "beamed" already a vcard from a mobile device to an other mobile device, you have used OBEX. But there are also other applications for the OBEX protocol. Most notably the filesystem browsing protocol. If the mobile device understands this protocol, you can browse, up and download files to your mobiles filesystem storage using this client implementations. Also syncronisation protocols like IrMCSync or SyncML have OBEX bindings and can be accessed using this client, even if there is no usage for syncronisation in konquerror.</para> + <para>OBEX protocols can use many different transports. The original transport was IrDA, but there also exsist transport bindings for Bluetooth, serial lines and tcp/ip connections.</para> + <para>OBEX supports 2 way authentication. The first, most known way, is authentications of the client by the server. So the server implementation can verify the clients identity. But also the client can verify the servers identity. For authentication a MD5 checksum challenge is used. This enshures that plain passwords are never sent over the transport medium.</para> + </sect2> + + <sect2 id="url_format"> + <title>URL format</title> + <para>OBEX resources are accessed using URLs. The protocol part is clearly obex: The path component holds the path on the server. The host part is a bit mor complex.</para> + <para>For servers accessible over tcp/ip the host part is as usual. You can use the hostname or ip address of the server host to contact. Also If the server runs on a non standard port (the standard port is 650) you can append the port number as usual. + Example: + <userinput>OBEX://hostname:port/path</userinput></para> + <para>For IrDA or Bluetooth transports you can use the hardware address in the standard notation with octets separated by double colons. Neat, but a bit difficult to remember the hardware address of your Bluetooth device. + Example: + <userinput>obex://[ef:01:23:45]/path</userinput> + or + <userinput>obex://[12:34:ef:01:23:45]/path</userinput></para> + <para>Therfore it is possible to define hostaliases for use with the OBEX protocol. These aliases are defined in the OBEX KControl module. You can set up a human readable name, discover devices and finally assign a hardware address to that name. Also Devices ober serial transports are accessible via those aliases. For IrDA and Bluetooth there are handy predefined aliases named irda or bluetooth. Both do device discovery and try to connect to the first device it finds.</para> + <para>Good luck browsing your neighbor's mobile :))</para> + </sect2> + + <sect2> + <title>Tips & Tricks</title> + <para> + Like every other tdeioslave, you can directly open and save files to bluetooth + devices with tdeio_obex. So if you write a shopping list for instance, you can + simply type it with kedit and save it on your phone. + </para> + <para> + You can make this procedure must faster by adding a bookmark to the + bookmark list of the file-save-dialog. + </para> + </sect2> + + <sect2> + <title>Limitations</title> + + <sect3 id="obex_and_tde"> + <title>OBEX and TDE</title> + <para>Since a tdeioclient can't control the number of slave which are accessing the same destination it is often the case that there are multiple slaves running. But OBEX transports, except the tcp/ip transport, support only one transport connection to the device. This leads to tdeioslaves which fail to connect with "Device or resource Busy". OBEX has a partial solution for that problem. If the server supports this, one can transmit packets for multiple connections on one transport connection. But, I have not seen a device which announced this feature. And this would require a separate transport daemon for each destination. So, if I see devices providing this feature, I will start to implement that daemon.</para> + <para>There is no special method to rename or move a file on the device. So this is done by copying the data from and to the device. This is slow and will start two tdeioslaves which will have the problem described above.</para> + </sect3> + + <sect3 id="devices"> + <title>Device compatibility</title> + <para>Since this client implements an open standard There is a real hope that there are much devices out there that will work well. But there are always exceptions.</para> + </sect3> + </sect2> +</sect1> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +sgml-general-insert-case: lower +End: +--> diff --git a/doc/en/tdeioclient.docbook b/doc/en/tdeioclient.docbook new file mode 100644 index 0000000..0645d80 --- /dev/null +++ b/doc/en/tdeioclient.docbook @@ -0,0 +1,8 @@ +<sect1 id="components.tdeioclient"> +<title>OBEX Push Client</title> + <sect2> + <title>What is this?</title> + <para>tdeioclient is a program that let you send files from your PC to any bluetooth device that support the OBEX (Object Exchange) Protocol. This Protocol is supported (probably) by all the older bluetooth cellular phones, palms and of course another PC with a bluetooth device (and possibly tdebluez installed!!!).</para> + </sect2> +</sect1> + |