how_to_build.txt

funambol window mobile客户端源代码

How to build the Funambol Windows Mobile Plug-in
--------------------------------------------------------------

1. To build the Funambol Windows Mobile Plug-in, both for Pocket PC and Smartphone, you will need: 

   * If using Microsoft Windows XP:
     - Microsoft Visual Studio 2005 (Standard or Professional) SP1 (Version 8.0.50727.762 or later) 
     - Microsoft .NET Framework Version 2.0.50727 SP1 
     - Windows Mobile 5.0 SDK for Pocket PC 
     - Windows Mobile 5.0 SDK for Smartphone
     - Windows Mobile 6.0 SDK for Pocket PC 
     - Windows Mobile 6.0 SDK for Smartphone
     - Active Sync 4.0.x
    
   * If using Windows Vista you will also need to: 
     - install Service Pack 1 (SP1 - KB926601), which can be obtained from Microsoft Download Center (http://msdn.microsoft.com/en-us/vstudio/bb265237.aspx)
     - install SP1 Update for Windows Vista, which can be obtained from Microsoft Download Center (http://www.microsoft.com/downloads/details.aspx?familyid=90e2942d-3ad1-4873-a2ee-4acc0aace5b6&displaylang=en)
     - instead of ActiveSync, use the Windows Mobile Device Center (http://www.microsoft.com/windowsmobile/devicecenter.mspx)
    
   * To build the installer you will also need: 
     - Apache Ant (http://ant.apache.org/) 
     - NSIS (http://nsis.sourceforge.net) 


2. In order to get the sources, execute the following commands (remember to use the r_v70 as _tag_): 

    cvs -d:pserver:[e-mail]:/cvsroot/sync4j login 
    cvs -z3 -d:pserver:[e-mail]:/cvsroot/sync4j co -r _tag_ *modulename*
    
    When prompted for a password, press Enter. This will checkout the source code in the current directory. 

    The *modulename* for the components are:
    - 3x/clients/winmobile (the component of the plug-in) 
    - 3x/client-api/native (the C++ API library) 
    - tools/zlib (the library to compress the HTTP code) 
    
    When all components have been downloaded, move the 'tool/zlib' directory in the '3x' directory. You will then have the following: 
    - 3x/client-api/native/...
    - 3x/tools/zlib
    - 3x/clients/winmobile/...

    Alternatively, you can get the source code (both for Pocket PC and Smartphone) from the zip shipped with the released version. The source file's name is funambol-pocketpc-plugin-src-7.0.x.zip.
    

3.  To build the installer for Pocket PC:

    1) Go to the folder: 'clients\winmobile\install\pocketpc\build'
    2) Open the file 'pocketpc.properties' using a text editor
       - redefine the path of Visual Studio 2005 (wm.vs2005) if needed
       - redefine the path of cabwiz (wm.cabwiz) if needed
       - redefine the path of NSIS (scpim.nsi) if needed
    3) Open a command prompt     
    4) Go to: 'clients\winmobile\install\pocketpc\build'
    5) Type 'ant release' 

    You will find the package in the directory 'clients\winmobile\install\pocketpc\wm5\output'.


4. To build the installer for Smartphone: 

    1) Go to the folder: 'clients\winmobile\install\smartphone\build'
    2) Open the file 'smartphone.properties' using a text editor
       - redefine the path of Visual Studio 2005 (wm.vs2005) if needed
       - redefine the path of cabwiz (wm.cabwiz) if needed
       - redefine the path of NSIS (scpim.nsi) if needed
    3) Open a command prompt     
    4) Go to: 'clients\winmobile\install\smartphone\build'
    5) Type 'ant release' 
    
    You will find the package in the directory 'clients\winmobile\install\smartphone\sphwm5\output'.


5. More:

    To open all the projects related to the Funambol Windows Mobile Plug-in and have a look at the source code, you can use the '3x/clients/winmobile/WMPlugin/WMPlugin.sln' solution. Open it using Visual Studio, choose the target you want to build for (Pocket PC or Smartphone) and you should be able to compile all the projects. 
    
    The single projects comprised by the Plug-in are: 
    - FunambolClient: contains the User Interface   
    - startsync: contains the executable to start the sync from different ways 
    - notlstnr: contains the dll that is responsible for listening for address changes 
    - handleservice: containts the executable used to perform some task registration 
    - setup: contains the dll that performs the actions needed during the setup process 
    - transport: contains the dll needed to create the Funambol email account 
    - mainclientdll: contains the dll core for the whole sync process 
    - ClientPush: contains the code responsible for discovering the client PIM modification to be synced
    - FunLanguage-en: contains the resources for the client localization in English 
    - FunLanguage-de: contains the resources for the client localization in German 
    - windowsmobile: contains the C++ API library