apps/dtnrespond/dtnrespond.1
changeset 1 44c5e3fa6d30
child 19 ce4cfc1cb1b6
equal deleted inserted replaced
0:2b3e5ec03512 1:44c5e3fa6d30
       
     1 .\"
       
     2 .\"    Copyright 2004-2006 Intel Corporation
       
     3 .\" 
       
     4 .\"    Licensed under the Apache License, Version 2.0 (the "License");
       
     5 .\"    you may not use this file except in compliance with the License.
       
     6 .\"    You may obtain a copy of the License at
       
     7 .\" 
       
     8 .\"        http://www.apache.org/licenses/LICENSE-2.0
       
     9 .\" 
       
    10 .\"    Unless required by applicable law or agreed to in writing, software
       
    11 .\"    distributed under the License is distributed on an "AS IS" BASIS,
       
    12 .\"    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       
    13 .\"    See the License for the specific language governing permissions and
       
    14 .\"    limitations under the License.
       
    15 .\"
       
    16 
       
    17 .TH dtnrespond 1 "November 16, 2010"
       
    18 .LO 1
       
    19 .SH NAME
       
    20 dtnrespond \- receive DTN queries 
       
    21 .SH SYNOPSIS
       
    22 .B dtnrespond
       
    23 .RB -l
       
    24 .IR eid
       
    25 .RB -f
       
    26 .IR matching_file
       
    27 .RB [ -n
       
    28 .IR num ]
       
    29 .RB [ -e
       
    30 .IR seconds ]
       
    31 .RB [ \-hv ]
       
    32 
       
    33 .SH DESCRIPTION
       
    34 .B dtnrespond
       
    35 listens for incoming query bundles. To do this,
       
    36 it connects to a dtnd daemon using the DTN API.
       
    37 It registers to receive bundles with the 
       
    38 .IR end‐point
       
    39 from the command line. It then blocks, waiting on
       
    40 bundles to arrive from dtnd. It terminates on SIGTERM (Ctrl-C)
       
    41 or after n query bundles have been received.
       
    42 .PP
       
    43 On receiving a query bundle
       
    44 .B dtnrespond
       
    45 will attempt to match the query based on the contents of the 
       
    46 .IR matching_file
       
    47 and will return the result (if available) to the source eid
       
    48 of the query bundle.
       
    49 
       
    50 .SH RETURN VALUES
       
    51 Returns 1 if there was an error processing the arguments.
       
    52 Otherwise 
       
    53 .B dtnrespond
       
    54 returns 0.
       
    55 
       
    56 .SH OPTIONS
       
    57 .TP
       
    58 .B \-\^l
       
    59 The EID on which to listen for the query bundles. It should be
       
    60 an endpoint for which the dtnd is responsible, but that
       
    61 is not currently enforced. (Required)
       
    62 .TP
       
    63 .B \-\^f
       
    64 The matching_file is a comma seperated value file that contains 
       
    65 information on the files to match against. See 
       
    66 .B dtnmatch.
       
    67 .TP
       
    68 .B \-\^n
       
    69 The number of queries to listen for before closing. Default: 0
       
    70 indicates
       
    71 .B dtnrespond
       
    72 should listen forever.
       
    73 .TP
       
    74 .B \-\^e
       
    75 The number of seconds until the response bundle expires from the DTN.
       
    76 Default is 3600 (one hour).
       
    77 .TP
       
    78 .B \-\^h
       
    79 Print a help message and exit.
       
    80 .TP
       
    81 .B \-\^v
       
    82 Be verbose. Adds diagnostic information to the standard output.
       
    83 
       
    84 .SH ENVIRONMENT
       
    85 .TP
       
    86 .B DTNAPI_ADDR
       
    87 If
       
    88 .B DTNAPI_ADDR
       
    89 is set, 
       
    90 .B dtnqueryrecv
       
    91 uses it as the hostname to connect to for DTN API operations.
       
    92 .TP
       
    93 .B DTNAPI_PORT
       
    94 If
       
    95 .B DTNAPI_PORT
       
    96 is set, its value is used as the TCP port to connect to
       
    97 for DTN API operations.
       
    98 .SH "SEE ALSO"
       
    99 dtnquery(1), dtnmatch(1), dtnd(8).