apps/dtnsend/dtnsend.1
changeset 0 2b3e5ec03512
equal deleted inserted replaced
-1:000000000000 0:2b3e5ec03512
       
     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 dtnsend 1 "September 4, 2005"
       
    18 .LO 1
       
    19 .SH NAME
       
    20 dtnsend \- send DTN bundles
       
    21 .SH SYNOPSIS
       
    22 .B dtnsend 
       
    23 .RB -s 
       
    24 .IR src
       
    25 .RB -d 
       
    26 .IR dest
       
    27 .RB -t
       
    28 .IR m|f|d
       
    29 .RB -p 
       
    30 .IR payload
       
    31 .RB [ -r 
       
    32 .IR reply-to ]
       
    33 .RB [ -n
       
    34 .IR num ]
       
    35 .RB [ -i 
       
    36 .IR regid ]
       
    37 .RB [ -e 
       
    38 .IR seconds ]
       
    39 .RB [ \-chvwCDFR ]
       
    40 
       
    41 .SH DESCRIPTION
       
    42 .B dtnsend
       
    43 injects a bundle into a DTN. To do this, it connects
       
    44 to a dtnd daemon using the DTN API. If
       
    45 .B \-\^w
       
    46 was specified, it registers to receive any bundle status
       
    47 reports that arrive for the reply-to EID (or the source-EID,
       
    48 if the reply-to EID was not specified).
       
    49 .PP
       
    50 Once it has connected to the dtnd and registered, it enters
       
    51 a loop, sending payloads and receiving status reports until
       
    52 the number of bundles requested have been sent.
       
    53 
       
    54 .SH RETURN VALUES
       
    55 Returns 1 if there was an error processing the arguments.
       
    56 Otherwise 
       
    57 .B dtnsend
       
    58 returns 0.
       
    59 
       
    60 .SH OPTIONS
       
    61 .TP
       
    62 .B \-\^c
       
    63 Request custody transfer. (Not currently implemented in dtnd.)
       
    64 .TP
       
    65 .B \-\^C
       
    66 Request custody transfer receipts. (Not currently implemented in dtnd.)
       
    67 .TP
       
    68 .B \-\^d
       
    69 The destination EID for the bundle. (Required)
       
    70 .TP
       
    71 .B \-\^D
       
    72 Request an end-to-end delivery receipt.
       
    73 .TP
       
    74 .B \-\^e
       
    75 The number of seconds until the bundle expires from the DTN. Default
       
    76 is 3600 (one hour).
       
    77 .TP
       
    78 .B \-\^F
       
    79 Request bundle forwarding receipts from every hop along the way.
       
    80 .TP
       
    81 .B \-\^i
       
    82 The registration ID to pass in to dtnd when registering.
       
    83 (Not currently implemented in DTN API.)
       
    84 .TP
       
    85 .B \-\^n
       
    86 The number of bundles to send.
       
    87 .TP
       
    88 .B \-\^r
       
    89 The reply-to EID for the bundle. If it is not specified, the
       
    90 source EID is used by default.
       
    91 .TP
       
    92 .B \-\^R
       
    93 Request bundle reception receipts from every hop along the way.
       
    94 .TP
       
    95 .B \-\^s
       
    96 The source EID for the bundle. It should be an endpoint for which
       
    97 the dtnd is responsible, but that is not currently enforced.
       
    98 (Required)
       
    99 .TP
       
   100 .B \-\^t
       
   101 Type of payload. Can be `m' for memory, `f' for file, or `d' for
       
   102 date. If type is `m', the
       
   103 .B \-\^p
       
   104 argument is used as the payload, byte for byte. If type is `f'
       
   105 the
       
   106 .B \-\^p
       
   107 argument is used as a filename which holds the bundle data. dtnd
       
   108 must have read permission for the file, as it will be the process
       
   109 reading the file, not
       
   110 .BR dtnsend .
       
   111 If type
       
   112 is `d' the current date is put into the bundle, and any
       
   113 .B \-\^p
       
   114 argument is ignored. (Required)
       
   115 .TP
       
   116 .B \-\^h
       
   117 Print a one-line help message and exit.
       
   118 .TP
       
   119 .B \-\^p
       
   120 The payload (when type is `m'), or the filename (when type is `f').
       
   121 Ignored when type is `d'.
       
   122 .TP
       
   123 .B \-\^v
       
   124 Be verbose. Adds diagnostic information to the standard output.
       
   125 .TP
       
   126 .B \-\^w
       
   127 After sending every payload, wait for one reply and print it.
       
   128 Note that it is currently impossible to see multiple replies with
       
   129 the
       
   130 .B \-\^w
       
   131 option. Instead, use
       
   132 .B dtnrecv
       
   133 in another window.
       
   134 
       
   135 .SH ENVIRONMENT
       
   136 .TP
       
   137 .B DTNAPI_ADDR
       
   138 If
       
   139 .B DTNAPI_ADDR
       
   140 is set, 
       
   141 .B dtnsend
       
   142 uses it as the hostname to connect to for DTN API operations.
       
   143 .TP
       
   144 .B DTNAPI_PORT
       
   145 If
       
   146 .B DTNAPI_PORT
       
   147 is set, its value is used as the TCP port to connect to
       
   148 for DTN API operations.
       
   149 .SH "SEE ALSO"
       
   150 dtnrecv(1), dtnd(8).
       
   151 .SH BUGS
       
   152 When
       
   153 .B dtnsend
       
   154 is listening for replies, it blocks and waits forever. If no response
       
   155 comes, it will never get around to sending the rest of the bundles
       
   156 it was requested to send. It would be better if it displayed bundle
       
   157 replies as the arrived instead, without blocking.