| | 1 | = HC_CHAT = |
| | 2 | |
| | 3 | == NAME == |
| | 4 | hc_chat - Simple chat using HAMcast stack |
| | 5 | |
| | 6 | == BUILD/INSTALL == |
| | 7 | |
| | 8 | === Requirements === |
| | 9 | |
| | 10 | - cmake (Version 2.6+) |
| | 11 | - cmake macro '!FindLibHamcast.cmake' |
| | 12 | - boost libraries developers edition |
| | 13 | - HAMcast library and middleware |
| | 14 | |
| | 15 | === Build === |
| | 16 | |
| | 17 | We recommend an 'out-of-source' cmake-build. Create a new folder, e.g. |
| | 18 | 'build' within the source directory. Change to new folder (cd build) |
| | 19 | and run: |
| | 20 | {{{ |
| | 21 | cmake ../ |
| | 22 | }}} |
| | 23 | if you have not install libhamcast to standard directories, run: |
| | 24 | {{{ |
| | 25 | cmake -DHAMCAST_INCLUDE_PATH=<path-to-headers> \ |
| | 26 | -DHAMCAST_LIBRARY_PATH=<path-to-libhamcast> ../ |
| | 27 | }}} |
| | 28 | |
| | 29 | 'path-to-headers' is the absolute path where 'hamcast/hamcast.hpp' can |
| | 30 | be found. 'path-to-libhamcast' is the absolute path where 'libhamcast.so' |
| | 31 | can be found. If both are the same, you have to provide only one of them. |
| | 32 | This will initialize build environment, if no errors occure run: |
| | 33 | {{{ |
| | 34 | make |
| | 35 | }}} |
| | 36 | |
| | 37 | If build was successful you find the binary in 'build' folder. |
| | 38 | |
| | 39 | === Install === |
| | 40 | |
| | 41 | Currently not supported. Just run hc_chat from build directory. |
| | 42 | |
| | 43 | == SYNOPSIS == |
| | 44 | {{{ |
| | 45 | hc_chat [GROUP] |
| | 46 | }}} |
| | 47 | |
| | 48 | == DESCRIPTION == |
| | 49 | |
| | 50 | The program is a simple chat client to send and receive multicast chat |
| | 51 | messages using HAMcast stack. It uses the default interface configured |
| | 52 | in HAMcast middleware. |
| | 53 | |
| | 54 | == EXIT STATUS == |
| | 55 | |
| | 56 | hc_chat exits with status 0 (EXIT_SUCCESS) if no errors occur, |
| | 57 | otherwise 1 (EXIT_FAILURE) is returned. |
| | 58 | |
| | 59 | == OPTIONS == |
| | 60 | |
| | 61 | None |
| | 62 | |
| | 63 | == EXAMPLES == |
| | 64 | |
| | 65 | Using default group (URI: ip//239.0.0.1:1234): |
| | 66 | {{{ |
| | 67 | ./hc_chat |
| | 68 | }}} |
| | 69 | Using specifc group: |
| | 70 | {{{ |
| | 71 | ./hc_chat <GROUP URI> |
| | 72 | }}} |
| | 73 | |
| | 74 | == FILES == |
| | 75 | |
| | 76 | No other files required or used. |
| | 77 | |
| | 78 | == ENVIRONMENT == |
| | 79 | |
| | 80 | {{{LD_LIBRARY_PATH}}} must be set if libhamcast is not installed into |
| | 81 | standard directories, e.g. {{{/usr/lib}}}. |
| | 82 | |
| | 83 | == NOTES == |
| | 84 | |
| | 85 | None |
