root/trunk/README

Revision 215, 4.1 KB (checked in by zany, 5 months ago)

adding bootstrap helper

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