| 1 | /** |
|---|
| 2 | \mainpage |
|---|
| 3 | |
|---|
| 4 | \section intro_sec Introduction |
|---|
| 5 | |
|---|
| 6 | ObexFTP implements the Object Exchange (OBEX) file transfer feature for |
|---|
| 7 | clients and servers. |
|---|
| 8 | |
|---|
| 9 | The standard is defined in more detail in section K12.5 (Profiles: OBEX FTP) |
|---|
| 10 | in Bluetooth V1.1 Profile Specifications. |
|---|
| 11 | |
|---|
| 12 | ObexFTP works out-of-the-box with all transports supported by OpenOBEX. |
|---|
| 13 | Currently there is IrDA, Bluetooth, USB and network (TCP) transport support. |
|---|
| 14 | ObexFTP also comes with ready to use custom transport support for many mobile |
|---|
| 15 | phones serial cables. |
|---|
| 16 | |
|---|
| 17 | It's well tested with Siemens and Sony/Ericsson mobile phones. But then most |
|---|
| 18 | Motorola and Sharp (generic) as well as Samsung phones will work too, please |
|---|
| 19 | contact the author if not. |
|---|
| 20 | |
|---|
| 21 | This ObexFTP distribution contains libraries as well as some applications. |
|---|
| 22 | |
|---|
| 23 | Applications to access e.g. Flex. Memory and Multimedia- /Secure Digital Card |
|---|
| 24 | memory on mobile equipment: |
|---|
| 25 | |
|---|
| 26 | - obexftp - all in one client application (heavy on options) |
|---|
| 27 | - Symlinks to obexftp for default operations: |
|---|
| 28 | - obexls - list the mobiles contents |
|---|
| 29 | - obexget - copy files(s) to mobile |
|---|
| 30 | - obexput - copy files(s) from mobile |
|---|
| 31 | - obexrm - remove files on the mobile |
|---|
| 32 | - obexftpd - obex ftp server application (experimental) |
|---|
| 33 | |
|---|
| 34 | Applications to hack Siemens mobile equipment using datalink cable |
|---|
| 35 | |
|---|
| 36 | - bfb_keysim - simulate key presses on the mobile |
|---|
| 37 | - bfb_eeprom - list and examine the user eeprom on the mobile |
|---|
| 38 | |
|---|
| 39 | Library parts to be used in other applications |
|---|
| 40 | |
|---|
| 41 | - obexftp - high level abstraction of OBEX FTP (SYNC, PUSH also) protocol |
|---|
| 42 | - multicobex - cable OBEX support for many phones (i.e. Siemens BFB and BFC |
|---|
| 43 | Sony/Ericsson, Motorola and generic (Sharp) modes) |
|---|
| 44 | - bfb - Siemens mobile datalink cable protocol layer |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | \section install_sec Short Installation Instructions |
|---|
| 48 | |
|---|
| 49 | To compile and install: |
|---|
| 50 | \verbatim |
|---|
| 51 | # ./configure |
|---|
| 52 | # make |
|---|
| 53 | # make install (as superuser) |
|---|
| 54 | \endverbatim |
|---|
| 55 | |
|---|
| 56 | If you plan to use a Siemens x45 or x55 series (e.g. S45 or C55, |
|---|
| 57 | not S65) use |
|---|
| 58 | \verbatim |
|---|
| 59 | CFLAGS="$CFLAGS -DCOMPAT_S45" ./configure |
|---|
| 60 | \endverbatim |
|---|
| 61 | instead |
|---|
| 62 | |
|---|
| 63 | Consider using pedantic error checking: |
|---|
| 64 | \verbatim |
|---|
| 65 | CFLAGS="$CFLAGS -Werror" ./configure |
|---|
| 66 | \endverbatim |
|---|
| 67 | |
|---|
| 68 | If compiling doesn't work, try to disable some of the language bindings on |
|---|
| 69 | configure. |
|---|
| 70 | \verbatim |
|---|
| 71 | --disable-perl --disable-python --disable-ruby --disable-tcl |
|---|
| 72 | \endverbatim |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | \section development_sec Further Development |
|---|
| 76 | |
|---|
| 77 | If this tool lacks support for your phone or just won't work quite right |
|---|
| 78 | please let me know. Development will focus on your needs. |
|---|
| 79 | |
|---|
| 80 | This package lacks advanced examples using the bindings. There are some 3rd |
|---|
| 81 | party GUIs and other projects like a obex file system though. Please see the |
|---|
| 82 | OpenOBEX / ObexFTP web site for details. |
|---|
| 83 | |
|---|
| 84 | Developers are free to use the bindings as well as obexftp, multicobex and |
|---|
| 85 | bfb libraries. Please join the mailing list and keep in touch - You'll |
|---|
| 86 | recieve pre-releases and support. That way your application can benefit from |
|---|
| 87 | the newest library features and further development can focus on your needs. |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | \section debugging_sec Debugging |
|---|
| 91 | |
|---|
| 92 | remove all ObexFTP installations from your system. Build using |
|---|
| 93 | \verbatim |
|---|
| 94 | CFLAGS="-DOBEXFTP_DEBUG=5" ./configure |
|---|
| 95 | make clean ; make |
|---|
| 96 | \endverbatim |
|---|
| 97 | Start debugging using |
|---|
| 98 | \verbatim |
|---|
| 99 | ./apps/obexftp [...] |
|---|
| 100 | \endverbatim |
|---|
| 101 | |
|---|
| 102 | You might want to try picking up compiler warnings too (and mail them to me) |
|---|
| 103 | \verbatim |
|---|
| 104 | CFLAGS="$CFLAGS -g -Wall -Wmissing-declarations -Wmissing-prototypes \ |
|---|
| 105 | -Werror" ./configure |
|---|
| 106 | make clean ; make |
|---|
| 107 | \endverbatim |
|---|
| 108 | Please mail me all warnings and errors, if any. |
|---|
| 109 | |
|---|
| 110 | The bindings use language-native installers which are missing the uninstall |
|---|
| 111 | targets. Our distcheck will boldly ignore those files. |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | \section contact_sec Author and Contact |
|---|
| 115 | |
|---|
| 116 | Author: Christian W. Zuckschwerdt <zany@triq.net> |
|---|
| 117 | - http://dev.zuckschwerdt.org/openobex/ |
|---|
| 118 | - http://openobex.sourceforge.net/ |
|---|
| 119 | - http://sourceforge.net/tracker/?group_id=8960 |
|---|
| 120 | - http://sourceforge.net/forum/?group_id=8960 |
|---|
| 121 | |
|---|
| 122 | */ |
|---|
