| | 1 | == HC_STATUS == |
| | 2 | |
| | 3 | NAME |
| | 4 | hc_status - Show status information for HAMcast middleware |
| | 5 | |
| | 6 | BUILD/INSTALL |
| | 7 | |
| | 8 | Requirements |
| | 9 | - cmake (Version 2.6+) |
| | 10 | - cmake macro 'FindLibHamcast.cmake' |
| | 11 | - boost libraries developers edition |
| | 12 | - HAMcast library and middleware |
| | 13 | |
| | 14 | Build |
| | 15 | We recommend an 'out-of-source' cmake-build. Create a new folder, e.g. |
| | 16 | 'build' within the source directory. Change to new folder (cd build) |
| | 17 | and run: |
| | 18 | |
| | 19 | cmake ../ |
| | 20 | |
| | 21 | if you have not install libhamcast to standard directories, run: |
| | 22 | |
| | 23 | cmake -DHAMCAST_INCLUDE_PATH=<path-to-headers> \ |
| | 24 | -DHAMCAST_LIBRARY_PATH=<path-to-libhamcast> ../ |
| | 25 | |
| | 26 | 'path-to-headers' is the absolute path where 'hamcast/hamcast.hpp' can |
| | 27 | be found. 'path-to-libhamcast' is the absolute path where 'libhamcast.so' |
| | 28 | can be found. If both are the same, you have to provide only one of them. |
| | 29 | This will initialize the build environment, if no errors occure run: |
| | 30 | |
| | 31 | make |
| | 32 | |
| | 33 | If build was successful you find the binary in 'build' folder. |
| | 34 | |
| | 35 | Install |
| | 36 | Currently not supported. Just run hc_status from build directory. |
| | 37 | |
| | 38 | SYNOPSIS |
| | 39 | hc_status [GROUPS]... |
| | 40 | |
| | 41 | DESCRIPTION |
| | 42 | |
| | 43 | The program provides information on HAMcast middleware and |
| | 44 | multicast status of a node. |
| | 45 | |
| | 46 | EXIT STATUS |
| | 47 | |
| | 48 | hc_status exits with status 0 (EXIT_SUCCESS) if no error occurs, |
| | 49 | otherwise 1 (EXIT_FAILURE) is returned. |
| | 50 | |
| | 51 | OPTIONS |
| | 52 | None |
| | 53 | |
| | 54 | EXAMPLES |
| | 55 | Without args: ./hc_status |
| | 56 | With args: ./hc_status ip://239.238.237.236:1234 ip://239.1.2.3:7890 |
| | 57 | |
| | 58 | FILES |
| | 59 | No other files required or used. |
| | 60 | |
| | 61 | NOTES |
| | 62 | If started without arguments hc_status prints current status of |
| | 63 | middleware and multicast group association. If valid group URIs are |
| | 64 | passed hc_status will 'join' these groups, print status infos and |
| | 65 | 'leave' groups before program stops. |
| | 66 | |
| | 67 | ENVIRONMENT |
| | 68 | LD_LIBRARY_PATH must be set if libhamcast is not installed into |
| | 69 | standard directories, e.g. /usr/lib. |
| | 70 | |
| | 71 | AUTHOR |
| | 72 | Sebastian Meiling <sebastian.meiling (at) haw-hamburg.de> |
| | 73 | |
| | 74 | visit our website <http://hamcast.realmv6.org/developers> |
