| | 1 | = IMG = |
| | 2 | |
| | 3 | == NAME == |
| | 4 | |
| | 5 | img - interdomain multicast gateway |
| | 6 | |
| | 7 | == BUILD/INSTALL == |
| | 8 | |
| | 9 | === Requirements === |
| | 10 | |
| | 11 | - cmake (Version 2.6+) |
| | 12 | - cmake macro 'FindLibHamcast.cmake' |
| | 13 | - boost libraries developers edition |
| | 14 | - HAMcast library and middleware |
| | 15 | |
| | 16 | === Build === |
| | 17 | |
| | 18 | We recommend an 'out-of-source' cmake-build. Create a new folder, e.g. |
| | 19 | 'build' within the source directory. Change to new folder (cd build) |
| | 20 | and run: |
| | 21 | {{{ |
| | 22 | cmake ../ |
| | 23 | }}} |
| | 24 | if you have not install libhamcast to standard directories, run: |
| | 25 | {{{ |
| | 26 | cmake -DHAMCAST_INCLUDE_PATH=<path-to-headers> \ |
| | 27 | -DHAMCAST_LIBRARY_PATH=<path-to-libhamcast> ../ |
| | 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 | If build was successful you find the binary in 'build' folder. |
| | 37 | |
| | 38 | === Install === |
| | 39 | |
| | 40 | Currently not supported. Just run img from build directory. |
| | 41 | |
| | 42 | == SYNOPSIS == |
| | 43 | |
| | 44 | {{{ |
| | 45 | img [OPTION]... |
| | 46 | }}} |
| | 47 | |
| | 48 | == DESCRIPTION == |
| | 49 | |
| | 50 | The program forwards multicast data between distinct HAMcast |
| | 51 | interfaces, i.e. multicast domains, based on configured multicast |
| | 52 | groups subscriptions. |
| | 53 | |
| | 54 | == EXIT STATUS == |
| | 55 | |
| | 56 | img exits with status 0 (EXIT_SUCCESS) if no errors occure, |
| | 57 | otherwise 1 (EXIT_FAILURE) is returned. |
| | 58 | |
| | 59 | == OPTIONS == |
| | 60 | |
| | 61 | -h, --help |
| | 62 | Print this help screen. |
| | 63 | |
| | 64 | -l, --list |
| | 65 | List all interfaces. |
| | 66 | |
| | 67 | -f, --file CONFIG |
| | 68 | Set CONFIG file with group list. |
| | 69 | |
| | 70 | -g, --group GROUP |
| | 71 | Set multicast GROUP URI. |
| | 72 | |
| | 73 | -u, --upstream IF |
| | 74 | Set upstream interface id IF. |
| | 75 | |
| | 76 | -d, --downstream IF |
| | 77 | Set downstream interface id IF. |
| | 78 | |
| | 79 | == EXAMPLES == |
| | 80 | |
| | 81 | Without CONFIG file: |
| | 82 | {{{ |
| | 83 | ./img -g ip://239.238.237.236:1234 -d 1 -u 2 |
| | 84 | }}} |
| | 85 | With CONFIG file: |
| | 86 | {{{ |
| | 87 | ./img -f img.cfg -d 1 -u 2 |
| | 88 | }}} |
| | 89 | |
| | 90 | == FILES == |
| | 91 | |
| | 92 | Optional CONFIG file (e.g. img.cfg) |
| | 93 | |
| | 94 | == ENVIRONMENT == |
| | 95 | |
| | 96 | LD_LIBRARY_PATH must be set if libhamcast is not installed into |
| | 97 | standard directories, e.g. {{{/usr/lib.}}} |
| | 98 | |
| | 99 | == NOTES == |
| | 100 | |
| | 101 | It is mandatory to either specify a config file (-f) or |
| | 102 | a group URI (-g) and interface IDs for upstream and downstream. |
| | 103 | |
| | 104 | Format of config file is: interface-ID=Group-URI |
