4 \page dcmqrti The Terminal Initiator Telnet Client Program
6 \page dcmqrti dcmqrti: The Terminal Initiator Telnet Client Program
9 \section synopsis SYNOPSIS
12 dcmqrti [options] peer...
15 \section description DESCRIPTION
17 The \b dcmqrti program (telnet initiator) is an interactive character based
18 program intended to be used for examining the dcmqrscp image databases and
19 sending images contained within these databases to Vendor nodes. During a
20 DICOM Demonstration the \b dcmqrti program can be activated by a Vendor by
21 logging onto the computer running the \b dcmqrscp program. Each vendor will
22 have their own login account and the \b dcmqrti program will be started
23 instead of a normal shell when they login.
25 The \b dcmqrti program takes one main argument, the hostname or vendor
26 symbolic name (from the VendorTable in the configuration file) of a Vendor.
27 It then searches in the configuration file for all AE titles associated with
28 this hostname or vendor name, and all storage areas accessable to these AE
29 titles. Thus only the accessable databases and peer applications discovered
30 in the configuration file are available as choices within the \b dcmqrti user
33 \section parameters PARAMETERS
36 peer peer host name or symbolic name from cfg file
39 \section options OPTIONS
41 \subsection general_options general options
44 print this help text and exit
47 print version information and exit
50 print expanded command line arguments
53 quiet mode, print no warnings and errors
56 verbose mode, print processing details
59 debug mode, print debug information
61 -ll --log-level [l]evel: string constant
62 (fatal, error, warn, info, debug, trace)
63 use level l for the logger
65 -lc --log-config [f]ilename: string
66 use config file f for the logger
68 -c --config [f]ilename: string
69 use specific configuration file
70 (default: /usr/local/etc/dcmqrscp.cfg)
73 \subsection network_options network options
75 -to --timeout [s]econds: integer (default: unlimited)
76 timeout for connection requests
78 -ta --acse-timeout [s]econds: integer (default: 30)
79 timeout for ACSE messages
81 -td --dimse-timeout [s]econds: integer (default: unlimited)
82 timeout for DIMSE messages
84 -xi --propose-implicit
85 propose implicit VR little endian TS only
87 -aet --aetitle [a]etitle: string
88 set my AE title (default: TELNET_INITIATOR)
90 -pdu --max-pdu [n]umber of bytes: integer (4096..131072)
91 set max receive pdu to n bytes
92 (default: use value from configuration file)
95 \subsection other_options other options
98 disable support for new VRs, convert to OB
100 -rmt --remote [t]itle: string
101 connect to remote database defined in cfg file
106 \subsection commands Commands
108 All commands can be abbreviated. An abbreviation is allowed if it does not
109 conflict with another command.
111 \subsubsection help_command "help" Command
113 The "help" command gives a summary of all available commands. Its output is
114 shown underneath. In order to separate the examples from surrounding text,
115 all examples are bracketted by dashed lines. These lines do not appear when
119 ------------------------------------------------------------
121 help list this summary
123 title [#] list [set] current peer AE title
124 database [#] list [set] current database
125 study [#] list [set] current study
126 series [#] list [set] current series
127 image [#] list [set] current image
128 display [#] display current [specific] image
129 send study [#] send current [specific] study
130 send series [#] send current [specific] series
131 send image [#] send current [specific] image
132 echo [#] verify connectivity [# times]
134 exit synonym for quit
135 ------------------------------------------------------------
138 \subsubsection title_command "title" Command
140 The "title" command without an argument allows the user to list the known
141 remote Application Entities (AE). An example output might look like:
144 ------------------------------------------------------------
146 Peer AE HostName:PortNumber
147 * 0) ACME1 (swallow:2001)
148 1) ACME2 (swallow:2002)
149 2) UNITED1 (kolibri:2001)
150 3) UNITED2 (kolibri:2002)
151 ------------------------------------------------------------
154 The current peer AE is marked with an asterisk (*). Each peer AE has an index
155 (second column) which can be used as an argument to the "title" command in
156 order to set the current peer AE. The third column gives the AE title of the
157 peer AE. The fourth column shows the hostname and TCP/IP port number of the
160 When invoked with an argument index, the "title" command will set the current
161 peer AE. The \b dcmqrti program will attempt to initate an association to the
162 current peer AE when asked to send a study/series/image or to send an echo.
164 \subsubsection database_command "database" Command
166 The "database" command without an argument allows the user to list the know
167 local databases (these correspond to dcmqrscp's Application Entity Titles).
168 An example output might look like:
171 ------------------------------------------------------------
178 ------------------------------------------------------------
181 The current database is marked with an asterisk (*). Each database has an
182 index (second column) which can be used as an argument to the "database"
183 command in order to set the current database. The third column shows the name
184 of the database (i.e. the dcmqrscp Application Entity title for the particular
187 When invoked with an argument index, the "database" command will set the
188 current database. The current database is used as the basis for further
189 database specific actions.
191 \subsubsection study_command "study" Command
193 The "study" command with no argument lists the studies in the current
194 database. An example output might look like:
197 ------------------------------------------------------------
198 Patient PatientID StudyID
199 * 0) JACKSON^ANDREW^^^ M4997106 20001
200 1) GRANT^MARY^^^ F4997108 20002
201 2) ARTHUR^CHESTER^^^ M4997107 20003
202 3) JEFFERSON^THOMAS^^^ M4997096 9465
203 4) MADISON^DOLLY^^^ F4997097 9443
205 4 Studies in Database: COMMON
206 ------------------------------------------------------------
209 The current study is marked with an asterisk (*). Each study has an index
210 (second column) which can be used as an argument to the "study" command in
211 order to set the current study. The third column shows the patient name, the
212 fourth column the patient ID and the fifth column the study ID.
214 When invoked with an argument index, the "study" command will set the current
215 study. The current study is used as the basis for further study specific
218 \subsubsection series_command "series" Command
220 The "series" command with no argument lists the series in the current study.
221 An example output might look like:
224 ------------------------------------------------------------
225 Series Modality SeriesInstanceUID
226 * 0) 1 MR 1.2.840.113654.2.3.1993.201
227 1) 2 MR 1.2.840.113654.2.3.1993.202
228 2) 3 MR 1.2.840.113654.2.3.1993.203
229 3) 4 MR 1.2.840.113654.2.3.1993.204
230 4) 5 MR 1.2.840.113654.2.3.1993.205
232 5 Series in StudyID 05381,
233 Patient: MONROE^JAMES^^^ (Database: COMMON)
234 ------------------------------------------------------------
237 The current series is marked with an asterisk (*). Each series has an index
238 (second column) which can be used as an argument to the "series" command in
239 order to set the current series. The third column shows the series number,
240 the fourth column the series modality, and the fifth column the series
243 When invoked with an argument index, the "series" command will set the current
244 series. The current series is used as the basis for further series specific
247 \subsubsection image_command "image" Command
249 The "image" command with no argument lists the images in the current series.
250 An example output might look like:
253 ------------------------------------------------------------
254 Image ImageInstanceUID
255 * 0) 1 1.2.840.113654.2.3.1993.9.123.6.2674
256 1) 2 1.2.840.113654.2.3.1993.9.123.6.2675
257 2) 3 1.2.840.113654.2.3.1993.9.123.6.2676
258 3) 4 1.2.840.113654.2.3.1993.9.123.6.2677
259 4) 5 1.2.840.113654.2.3.1993.9.123.6.2678
260 5) 6 1.2.840.113654.2.3.1993.9.123.6.2679
261 6) 7 1.2.840.113654.2.3.1993.9.123.6.2680
262 7) 8 1.2.840.113654.2.3.1993.9.123.6.2681
263 8) 9 1.2.840.113654.2.3.1993.9.123.6.2682
264 9) 10 1.2.840.113654.2.3.1993.9.123.6.2683
265 10) 11 1.2.840.113654.2.3.1993.9.123.6.2684
266 11) 12 1.2.840.113654.2.3.1993.9.123.6.2685
267 12) 13 1.2.840.113654.2.3.1993.9.123.6.2686
269 13 Images in MR Series, StudyID 05381,
270 Patient: MONROE^JAMES^^^ (Database: COMMON)
271 ------------------------------------------------------------
274 The current image is marked with an asterisk (*). Each image has an index
275 (second column) which can be used as an argument to the "image" command in
276 order to set the current image. The third column shows the image number, and
277 the fourth column the image instance UID (SOP Instance UID).
279 When invoked with an argument index, the "image" command will set the current
280 image. The current image is used as the basis for further image specific
283 \subsubsection display_command "display" Command
285 The display command serves no purpose in the current version of DCMTK. It was
286 used in prior releases to request the CTN Display Program to display an image.
288 \subsubsection send_command "send" Command
290 The "send" command allows a complete study/series or individual image to be
291 stored on a remote AE. When this command is invoked, the \b dcmqrti program
292 will operate as a SCU of the DICOM Storage Service Class and attempt to
293 initiate an association with the current peer AE (defined via the "title"
294 command). Presentation contexts for all relevant Storage SOP Classes will be
295 proposed. An attempt will be made to store all specified images. If no
296 association could be negotiated an error message will be printed. If an
297 storage operation fails or if no appropriate presentation context is available
298 and error message will be printed.
301 The "send" command exists in three forms:
308 The "study" keyword means send all images in the current study. When invoked
309 with an argument index, the specified study in the current database will be
310 stored. The "series" keyword means send all images in the current series.
311 When invoked with an argument index, the specified series in the current study
312 will be stored. The "image" keyword means send the current image. When
313 invoked with an argument index, the specified image in the current series will
316 When an image is stored, a message will be printed of the form:
318 ------------------------------------------------------------
319 New Association Started (swallow:2001,ACME1)
321 PatientName: JACKSON^ANDREW^^^, StudyID: 20001,
322 Series: 2, Modality: CR, Image: 1,
323 Image UID: 1.2.840.113654.2.3.1993.9.123.6.1834
324 0%________25%_________50%__________75%________100%
325 --------------------------------------------------
326 [MsgID 1] Complete [Status: Success]
327 Released Association (swallow:2001,ACME1)
328 ------------------------------------------------------------
331 \subsubsection echo_command "echo" Command
333 The "echo" command allows the user to verify connectivity with the current
334 peer AE (defined via the "title" command). When invoked, the \b dcmqrti
335 program acts as an SCU of the Verification Service Class.
337 When invoked without an argument, only one C-ECHO message is generated. When
338 invoked with an argument, the specified number of C-ECHO messages will be
339 sent. A message will be printed of the form:
342 ------------------------------------------------------------
343 New Association Started (localhost:2001,CMOVE)
344 [MsgID 1] Echo, Complete [Status: Success]
345 Released Association (localhost:2001,CMOVE)
346 ------------------------------------------------------------
349 \subsubsection quit_exit_commands "quit", "exit" Commands
351 The "quit" and "exit" commands have the same effect. They terminate the
354 \subsection dicom_conformance DICOM Conformance
356 The \b dcmqrti application supports the same set of SOP Classes as an SCU as
357 the \b dcmqrscp application - see dcmqrscp documentation.
359 The \b dcmqrti application will propose presentation contexts for all of the
360 abovementioned supported SOP Classes using the transfer syntaxes:
363 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
364 LittleEndianExplicitTransferSyntax 1.2.840.10008.1.2.1
365 BigEndianExplicitTransferSyntax 1.2.840.10008.1.2.2
368 The \b dcmqrti application does not support extended negotiation.
370 \subsection configuration Configuration
372 The \b dcmqrti program uses the same configuration file as the \b dcmqrscp
373 program. See the documentation on configuration for more information
374 (<em>dcmqrcnf.txt</em> and the example configuration file
375 <em>dcmqrscp.cfg</em>).
377 \section logging LOGGING
379 The level of logging output of the various command line tools and underlying
380 libraries can be specified by the user. By default, only errors and warnings
381 are written to the standard error stream. Using option \e --verbose also
382 informational messages like processing details are reported. Option
383 \e --debug can be used to get more details on the internal activity, e.g. for
384 debugging purposes. Other logging levels can be selected using option
385 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
386 very severe error events, the application will usually terminate. For more
387 details on the different logging levels, see documentation of module "oflog".
389 In case the logging output should be written to file (optionally with logfile
390 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
391 can be used. This configuration file also allows for directing only certain
392 messages to a particular output stream and for filtering certain messages
393 based on the module or application where they are generated. An example
394 configuration file is provided in <em><etcdir>/logger.cfg</em>).
396 \section command_line COMMAND LINE
398 All command line tools use the following notation for parameters: square
399 brackets enclose optional values (0-1), three trailing dots indicate that
400 multiple values are allowed (1-n), a combination of both means 0 to n values.
402 Command line options are distinguished from parameters by a leading '+' or '-'
403 sign, respectively. Usually, order and position of command line options are
404 arbitrary (i.e. they can appear anywhere). However, if options are mutually
405 exclusive the rightmost appearance is used. This behaviour conforms to the
406 standard evaluation rules of common Unix shells.
408 In addition, one or more command files can be specified using an '@' sign as a
409 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
410 is replaced by the content of the corresponding text file (multiple
411 whitespaces are treated as a single separator unless they appear between two
412 quotation marks) prior to any further evaluation. Please note that a command
413 file cannot contain another command file. This simple but effective approach
414 allows to summarize common combinations of options/parameters and avoids
415 longish and confusing command lines (an example is provided in file
416 <em><datadir>/dumppat.txt</em>).
418 \section environment ENVIRONMENT
420 The \b dcmqrti utility will attempt to load DICOM data dictionaries specified
421 in the \e DCMDICTPATH environment variable. By default, i.e. if the
422 \e DCMDICTPATH environment variable is not set, the file
423 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built into
424 the application (default for Windows).
426 The default behaviour should be preferred and the \e DCMDICTPATH environment
427 variable only used when alternative data dictionaries are required. The
428 \e DCMDICTPATH environment variable has the same format as the Unix shell
429 \e PATH variable in that a colon (":") separates entries. On Windows systems,
430 a semicolon (";") is used as a separator. The data dictionary code will
431 attempt to load each file specified in the \e DCMDICTPATH environment variable.
432 It is an error if no data dictionary can be loaded.
436 <em><docdir>/dcmqrcnf.txt</em> - configuration information
437 \n<em><docdir>/dcmqrset.txt</em> - setup information
438 \n<em><etcdir>/dcmqrscp.cfg</em> - example configuration file
440 \section see_also SEE ALSO
444 \section copyright COPYRIGHT
446 Copyright (C) 1993-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.