2 .\" Copyright (c) 2001-2003
3 .\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
4 .\" All rights reserved.
6 .\" Author: Harti Brandt <harti@FreeBSD.org>
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" $Begemot: libunimsg/sscop/sscop.1,v 1.3 2004/07/08 08:22:28 brandt Exp $
36 .Nd "SSCOP transport protocol"
42 .Op Fl a Ar p Ns Li = Ns Ar v
44 .Op Fl t Ar t Ns Li = Ns Ar m
49 tool implements the Q.2110 transport protocol.
50 Normally the program reads from standard input and sends this input over
51 the SSCOP protocol on the standard output file descriptor. This means, that
52 the standard output file descriptor should be connected in read-write mode.
55 .Bl -tag -width ".It Fl a Ar p Ns Li = Ns Ar v"
57 Use frameing on the SSCOP connection (see the
61 Set the verbose flag to the hex value
64 Set the initial SSCOP window to
66 .It Fl a Ar p Ns Li = Ns Ar v
71 The following parameters may be set:
72 .Bl -tag -width ".It Li stat Ns = Ns Ar N"
74 Set the maximum SSCOP-UU data size to
78 Set the maximum SSCOP SDU data size to
81 .It Li cc Ns = Ns Ar N
84 (maximum number of connection control message re-transmissions) to
87 .It Li pd Ns = Ns Ar N
90 (maximum acceptable number of outstanding unacknowledged SD PDUs before
91 sending a POLL) to the value
93 .It Li stat Ns = Ns Ar N
96 (maximum number of elements placed in a STAT PDU) to the value
100 Enable the ATM-Forum SSCOP robustness enhancement.
102 Exit when there is an end of file condition on the input file or the
103 SSCOP indicates a release confirmation.
105 Use the framing protocol for communication over the SSCOP link. See
107 (libbegemot) for framing.
109 Print a short help information and exit.
111 Try not to read from the user input file descriptor. Assume that we a receiving
114 Loose every Nth message. This is used for testing.
116 Revert user and SSCOP file descriptors. That means, that user input and output
117 is done on standard output and SSCOP input and output on standard input.
118 .It Fl t Ar t Ns Li = Ns Ar m
123 milliseconds. The following timers may be set:
124 .Bl -tag -width ".It Li stat Ns = Ns Ar N"
125 .It Li cc Ns = Ns Ar m
126 Set the connection control timer to
128 This timer controls the retransmission of connection control messages.
129 .It Li poll Ns = Ns Ar m
130 Set the poll timer to
132 This timer controls the transmission of POLL messages.
133 .It Li ka Ns = Ns Ar m
134 Set the keep-alive timer to
136 This timer controls the maximum length of the transient phase.
137 .It Li nr Ns = Ns Ar m
138 Set the no-response timer to
140 This timer controls the maximum time between two received STAT PDUs before
141 the connection is aborted.
142 .It Li idle Ns = Ns Ar m
143 Set the idle timer to
145 This timer controls the length of the idle phase.
148 Set the SSCOP library verbose flag to the hex value.
150 Don't start the SSCOP protocol. Wait for a establish indication from the remote
153 Enable to POLL after retransmission flag.
155 Send user output to file descriptor 3.
158 The following command line sends the file
160 over a pipe (this depends on the feature that pipes are bi-directional):
162 cat Makefile | sscop -reF | sscop -weF
167 The implemented protocol conforms to ITU-T recommendation Q.2110.
169 .An Hartmut Brandt Aq harti@FreeBSD.org