HAMcast developers

Changes between Version 1 and Version 2 of documentation/tools/hcstatus


Ignore:
Timestamp:
02/14/12 08:45:23 (13 years ago)
Author:
Sebastian Meiling
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • documentation/tools/hcstatus

    v1 v2  
    1 == HC_STATUS ==
     1= HC_STATUS =
    22
    3 NAME
     3==NAME==
    44    hc_status - Show status information for HAMcast middleware
    55
    6 BUILD/INSTALL
     6==BUILD/INSTALL==
    77
    8 Requirements
     8===Requirements===
    99    - cmake (Version 2.6+)
    1010    - cmake macro 'FindLibHamcast.cmake'
    … …  
    1212    - HAMcast library and middleware
    1313
    14 Build
     14===Build===
    1515    We recommend an 'out-of-source' cmake-build. Create a new folder, e.g.
    1616    'build' within the source directory. Change to new folder (cd build)
    1717    and run:
    18 
     18{{{
    1919        cmake ../
    20 
     20}}}
    2121    if you have not install libhamcast to standard directories, run:
    22 
     22{{{
    2323        cmake -DHAMCAST_INCLUDE_PATH=<path-to-headers> \
    2424              -DHAMCAST_LIBRARY_PATH=<path-to-libhamcast> ../
    25 
     25}}}
    2626    'path-to-headers' is the absolute path where 'hamcast/hamcast.hpp' can
    2727    be found. 'path-to-libhamcast' is the absolute path where 'libhamcast.so'
    2828    can be found. If both are the same, you have to provide only one of them.
    2929    This will initialize the build environment, if no errors occure run:
    30 
     30{{{
    3131        make
    32 
     32}}}
    3333    If build was successful you find the binary in 'build' folder.
    3434
    35 Install
     35===Install===
    3636    Currently not supported. Just run hc_status from build directory.
    3737
    38 SYNOPSIS
     38==SYNOPSIS==
     39{{{
    3940    hc_status [GROUPS]...
    40 
    41 DESCRIPTION
     41}}}
     42==DESCRIPTION==
    4243
    4344    The program provides information on HAMcast middleware and
    4445    multicast status of a node.
    4546
    46 EXIT STATUS
     47==EXIT STATUS==
    4748
    4849    hc_status exits with status 0 (EXIT_SUCCESS) if no error occurs,
    4950    otherwise 1 (EXIT_FAILURE) is returned.
    5051
    51 OPTIONS
     52==OPTIONS==
    5253    None
    5354
    54 EXAMPLES
    55     Without args:   ./hc_status
    56     With args:      ./hc_status ip://239.238.237.236:1234 ip://239.1.2.3:7890
     55==EXAMPLES==
     56    Without args:   
     57{{{
     58./hc_status
     59}}}
     60    With args:     
     61{{{
     62./hc_status ip://239.238.237.236:1234 ip://239.1.2.3:7890
     63}}}
    5764
    58 FILES
     65==FILES==
    5966    No other files required or used.
    6067
    61 NOTES
     68==NOTES==
    6269    If started without arguments hc_status prints current status of
    6370    middleware and multicast group association. If valid group URIs are
    … …  
    6572    'leave' groups before program stops.
    6673
    67 ENVIRONMENT
     74==ENVIRONMENT==
    6875    LD_LIBRARY_PATH must be set if libhamcast is not installed into
    6976    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>