4 \page echoscu DICOM verification (C-ECHO) SCU
6 \page echoscu echoscu: DICOM verification (C-ECHO) SCU
9 \section synopsis SYNOPSIS
12 echoscu [options] peer port
15 \section description DESCRIPTION
17 The \b echoscu application implements a Service Class User (SCU) for the
18 Verification SOP Class. It sends a DICOM C-ECHO message to a Service
19 Class Provider (SCP) and waits for a response. The application can be
20 used to verify basic DICOM connectivity.
22 \section parameters PARAMETERS
25 peer hostname of DICOM peer
27 port tcp/ip port number of peer
30 \section options OPTIONS
32 \subsection general_options general options
35 print this help text and exit
38 print version information and exit
41 print expanded command line arguments
44 quiet mode, print no warnings and errors
47 verbose mode, print processing details
50 debug mode, print debug information
52 -ll --log-level [l]evel: string constant
53 (fatal, error, warn, info, debug, trace)
54 use level l for the logger
56 -lc --log-config [f]ilename: string
57 use config file f for the logger
60 \subsection network_options network options
62 application entity titles:
64 -aet --aetitle [a]etitle: string
65 set my calling AE title (default: ECHOSCU)
67 -aec --call [a]etitle: string
68 set called AE title of peer (default: ANY-SCP)
70 association negotiation debugging:
72 -pts --propose-ts [n]umber: integer (1..28)
73 propose n transfer syntaxes
75 -ppc --propose-pc [n]umber: integer (1..128)
76 propose n presentation contexts
78 other network options:
80 -to --timeout [s]econds: integer (default: unlimited)
81 timeout for connection requests
83 -ta --acse-timeout [s]econds: integer (default: 30)
84 timeout for ACSE messages
86 -td --dimse-timeout [s]econds: integer (default: unlimited)
87 timeout for DIMSE messages
89 -pdu --max-pdu [n]umber of bytes: integer (4096..131072)
90 set max receive pdu to n bytes (default: 16384)
92 --repeat [n]umber: integer
96 abort association instead of releasing it
99 \subsection tls_options transport layer security (TLS) options
101 transport protocol stack:
104 use normal TCP/IP connection (default)
106 +tls --enable-tls [p]rivate key file, [c]ertificate file: string
107 use authenticated secure TLS connection
110 use secure TLS connection without certificate
112 private key password (only with --enable-tls):
115 prompt user to type password on stdin (default)
117 +pw --use-passwd [p]assword: string
118 use specified password
121 use empty string as password
123 key and certificate file format:
126 read keys and certificates as PEM file (default)
129 read keys and certificates as DER file
131 certification authority:
132 +cf --add-cert-file [c]ertificate filename: string
133 add certificate file to list of certificates
135 +cd --add-cert-dir [c]ertificate directory: string
136 add certificates in d to list of certificates
140 +cs --cipher [c]iphersuite name: string
141 add ciphersuite to list of negotiated suites
143 +dp --dhparam [f]ilename: string
144 read DH parameters for DH/DSS ciphersuites
146 pseudo random generator:
148 +rs --seed [f]ilename: string
149 seed random generator with contents of f
152 write back modified seed (only with --seed)
154 +wf --write-seed-file [f]ilename: string (only with --seed)
155 write modified seed to file f
159 -rc --require-peer-cert
160 verify peer certificate, fail if absent (default)
162 -vc --verify-peer-cert
163 verify peer certificate if present
165 -ic --ignore-peer-cert
166 don't verify peer certificate
171 \subsection dicom_conformance DICOM Conformance
173 The \b echoscu application supports the following SOP Classes as an SCU:
176 VerificationSOPClass 1.2.840.10008.1.1
179 Unless the \e --propose-ts option is used, the echoscu application will only
180 propose the transfer syntax
183 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
186 \section logging LOGGING
188 The level of logging output of the various command line tools and underlying
189 libraries can be specified by the user. By default, only errors and warnings
190 are written to the standard error stream. Using option \e --verbose also
191 informational messages like processing details are reported. Option
192 \e --debug can be used to get more details on the internal activity, e.g. for
193 debugging purposes. Other logging levels can be selected using option
194 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
195 very severe error events, the application will usually terminate. For more
196 details on the different logging levels, see documentation of module "oflog".
198 In case the logging output should be written to file (optionally with logfile
199 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
200 can be used. This configuration file also allows for directing only certain
201 messages to a particular output stream and for filtering certain messages
202 based on the module or application where they are generated. An example
203 configuration file is provided in <em><etcdir>/logger.cfg</em>).
205 \section command_line COMMAND LINE
207 All command line tools use the following notation for parameters: square
208 brackets enclose optional values (0-1), three trailing dots indicate that
209 multiple values are allowed (1-n), a combination of both means 0 to n values.
211 Command line options are distinguished from parameters by a leading '+' or '-'
212 sign, respectively. Usually, order and position of command line options are
213 arbitrary (i.e. they can appear anywhere). However, if options are mutually
214 exclusive the rightmost appearance is used. This behaviour conforms to the
215 standard evaluation rules of common Unix shells.
217 In addition, one or more command files can be specified using an '@' sign as a
218 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
219 is replaced by the content of the corresponding text file (multiple
220 whitespaces are treated as a single separator unless they appear between two
221 quotation marks) prior to any further evaluation. Please note that a command
222 file cannot contain another command file. This simple but effective approach
223 allows to summarize common combinations of options/parameters and avoids
224 longish and confusing command lines (an example is provided in file
225 <em><datadir>/dumppat.txt</em>).
227 \section environment ENVIRONMENT
229 The \b echoscu utility will attempt to load DICOM data dictionaries specified
230 in the \e DCMDICTPATH environment variable. By default, i.e. if the
231 \e DCMDICTPATH environment variable is not set, the file
232 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
233 into the application (default for Windows).
235 The default behaviour should be preferred and the \e DCMDICTPATH environment
236 variable only used when alternative data dictionaries are required. The
237 \e DCMDICTPATH environment variable has the same format as the Unix shell
238 \e PATH variable in that a colon (":") separates entries. On Windows systems,
239 a semicolon (";") is used as a separator. The data dictionary code will
240 attempt to load each file specified in the \e DCMDICTPATH environment variable.
241 It is an error if no data dictionary can be loaded.
243 \section copyright COPYRIGHT
245 Copyright (C) 1994-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.