OFFIS DCMTK  Version 3.6.0
termscu.man
1 /*!
2 
3 \if MANPAGES
4 \page termscu DICOM termination SCU
5 \else
6 \page termscu termscu: DICOM termination SCU
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 termscu [options] peer port
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b termscu application implements a Service Class User (SCU) for DCMTK's
18 private Shutdown SOP Class. It tries to negotiate this private Shutdown SOP
19 Class with a Service Class Provider (SCP) which (if this feature is
20 implemented) will immediately shutdown after refusing the association.
21 The application can be used to shutdown some of DCMTK's server applications.
22 
23 \section parameters PARAMETERS
24 
25 \verbatim
26 peer hostname of DICOM peer
27 
28 port tcp/ip port number of peer
29 \endverbatim
30 
31 \section options OPTIONS
32 
33 \subsection general_options general options
34 \verbatim
35  -h --help
36  print this help text and exit
37 
38  --version
39  print version information and exit
40 
41  --arguments
42  print expanded command line arguments
43 
44  -q --quiet
45  quiet mode, print no warnings and errors
46 
47  -v --verbose
48  verbose mode, print processing details
49 
50  -d --debug
51  debug mode, print debug information
52 
53  -ll --log-level [l]evel: string constant
54  (fatal, error, warn, info, debug, trace)
55  use level l for the logger
56 
57  -lc --log-config [f]ilename: string
58  use config file f for the logger
59 \endverbatim
60 
61 \subsection network_options network options
62 \verbatim
63 application entity titles:
64 
65  -aet --aetitle [a]etitle: string
66  set my calling AE title (default: ECHOSCU)
67 
68  -aec --call [a]etitle: string
69  set called AE title of peer (default: ANY-SCP)
70 
71 other network options:
72 
73  -pdu --max-pdu [n]umber of bytes: integer (4096..131072)
74  set max receive pdu to n bytes (default: 16384)
75 \endverbatim
76 
77 \section notes NOTES
78 
79 \subsection dicom_conformance DICOM Conformance
80 
81 The \b termscu application supports the following SOP Classes as an SCU:
82 
83 \verbatim
84 PrivateShutdownSOPClass 1.2.276.0.7230010.3.4.1915765545.18030.917282194.0
85 \endverbatim
86 
87 \section logging LOGGING
88 
89 The level of logging output of the various command line tools and underlying
90 libraries can be specified by the user. By default, only errors and warnings
91 are written to the standard error stream. Using option \e --verbose also
92 informational messages like processing details are reported. Option
93 \e --debug can be used to get more details on the internal activity, e.g. for
94 debugging purposes. Other logging levels can be selected using option
95 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
96 very severe error events, the application will usually terminate. For more
97 details on the different logging levels, see documentation of module "oflog".
98 
99 In case the logging output should be written to file (optionally with logfile
100 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
101 can be used. This configuration file also allows for directing only certain
102 messages to a particular output stream and for filtering certain messages
103 based on the module or application where they are generated. An example
104 configuration file is provided in <em><etcdir>/logger.cfg</em>).
105 
106 \section command_line COMMAND LINE
107 
108 All command line tools use the following notation for parameters: square
109 brackets enclose optional values (0-1), three trailing dots indicate that
110 multiple values are allowed (1-n), a combination of both means 0 to n values.
111 
112 Command line options are distinguished from parameters by a leading '+' or '-'
113 sign, respectively. Usually, order and position of command line options are
114 arbitrary (i.e. they can appear anywhere). However, if options are mutually
115 exclusive the rightmost appearance is used. This behaviour conforms to the
116 standard evaluation rules of common Unix shells.
117 
118 In addition, one or more command files can be specified using an '@' sign as a
119 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
120 is replaced by the content of the corresponding text file (multiple
121 whitespaces are treated as a single separator unless they appear between two
122 quotation marks) prior to any further evaluation. Please note that a command
123 file cannot contain another command file. This simple but effective approach
124 allows to summarize common combinations of options/parameters and avoids
125 longish and confusing command lines (an example is provided in file
126 <em><datadir>/dumppat.txt</em>).
127 
128 \section environment ENVIRONMENT
129 
130 The \b termscu utility will attempt to load DICOM data dictionaries specified
131 in the \e DCMDICTPATH environment variable. By default, i.e. if the
132 \e DCMDICTPATH environment variable is not set, the file
133 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
134 into the application (default for Windows).
135 
136 The default behaviour should be preferred and the \e DCMDICTPATH environment
137 variable only used when alternative data dictionaries are required. The
138 \e DCMDICTPATH environment variable has the same format as the Unix shell
139 \e PATH variable in that a colon (":") separates entries. On Windows systems,
140 a semicolon (";") is used as a separator. The data dictionary code will
141 attempt to load each file specified in the \e DCMDICTPATH environment variable.
142 It is an error if no data dictionary can be loaded.
143 
144 \section copyright COPYRIGHT
145 
146 Copyright (C) 2005-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
147 
148 */


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11