OFFIS DCMTK  Version 3.6.0
dcmpssnd.man
1 /*!
2 
3 \if MANPAGES
4 \page dcmpssnd Network send for presentation state viewer
5 \else
6 \page dcmpssnd dcmpssnd: Network send for presentation state viewer
7 \endif
8 
9 \section synopsis SYNOPSIS
10 
11 \verbatim
12 dcmpssnd [options] config-file target study [series] [instance]
13 \endverbatim
14 
15 \section description DESCRIPTION
16 
17 The \b dcmpssnd application is invoked by the Grayscale Softcopy Presentation
18 State Viewer and is not intended to be invoked manually. The application
19 reads the common configuration file which is shared between the different
20 components of the viewer, attempts to establish a DICOM association with
21 the selected target and, if successful, selects the required DICOM
22 instances from the viewer's database and transmits them using the DICOM
23 storage service class, which is supported as SCU. When transmission is
24 finished (successfully or unsuccessfully), the application terminates. This
25 application supports the same storage SOP classes as the \b storescu utility,
26 but does not support encapsulated transfer syntaxes. See the full
27 conformance statement for further details.
28 
29 
30 \section parameters PARAMETERS
31 
32 \verbatim
33 config-file configuration file to be read
34 
35 target symbolic identifier of send target in config file
36 
37 study study instance UID of study in database to be sent
38 
39 series series instance UID (default: send complete study)
40 
41 instance SOP instance UID (default: send complete series)
42 \endverbatim
43 
44 \section options OPTIONS
45 
46 \subsection general_options general options
47 \verbatim
48  -h --help
49  print this help text and exit
50 
51  --version
52  print version information and exit
53 
54  --arguments
55  print expanded command line arguments
56 
57  -q --quiet
58  quiet mode, print no warnings and errors
59 
60  -v --verbose
61  verbose mode, print processing details
62 
63  -d --debug
64  debug mode, print debug information
65 
66  -ll --log-level [l]evel: string constant
67  (fatal, error, warn, info, debug, trace)
68  use level l for the logger
69 
70  -lc --log-config [f]ilename: string
71  use config file f for the logger
72 \endverbatim
73 
74 \section logging LOGGING
75 
76 The level of logging output of the various command line tools and underlying
77 libraries can be specified by the user. By default, only errors and warnings
78 are written to the standard error stream. Using option \e --verbose also
79 informational messages like processing details are reported. Option
80 \e --debug can be used to get more details on the internal activity, e.g. for
81 debugging purposes. Other logging levels can be selected using option
82 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
83 very severe error events, the application will usually terminate. For more
84 details on the different logging levels, see documentation of module "oflog".
85 
86 In case the logging output should be written to file (optionally with logfile
87 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
88 can be used. This configuration file also allows for directing only certain
89 messages to a particular output stream and for filtering certain messages
90 based on the module or application where they are generated. An example
91 configuration file is provided in <em><etcdir>/logger.cfg</em>).
92 
93 \section command_line COMMAND LINE
94 
95 All command line tools use the following notation for parameters: square
96 brackets enclose optional values (0-1), three trailing dots indicate that
97 multiple values are allowed (1-n), a combination of both means 0 to n values.
98 
99 Command line options are distinguished from parameters by a leading '+' or '-'
100 sign, respectively. Usually, order and position of command line options are
101 arbitrary (i.e. they can appear anywhere). However, if options are mutually
102 exclusive the rightmost appearance is used. This behaviour conforms to the
103 standard evaluation rules of common Unix shells.
104 
105 In addition, one or more command files can be specified using an '@' sign as a
106 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
107 is replaced by the content of the corresponding text file (multiple
108 whitespaces are treated as a single separator unless they appear between two
109 quotation marks) prior to any further evaluation. Please note that a command
110 file cannot contain another command file. This simple but effective approach
111 allows to summarize common combinations of options/parameters and avoids
112 longish and confusing command lines (an example is provided in file
113 <em><datadir>/dumppat.txt</em>).
114 
115 \section environment ENVIRONMENT
116 
117 The \b dcmpssnd utility will attempt to load DICOM data dictionaries specified
118 in the \e DCMDICTPATH environment variable. By default, i.e. if the
119 \e DCMDICTPATH environment variable is not set, the file
120 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
121 into the application (default for Windows).
122 
123 The default behaviour should be preferred and the \e DCMDICTPATH environment
124 variable only used when alternative data dictionaries are required. The
125 \e DCMDICTPATH environment variable has the same format as the Unix shell
126 \e PATH variable in that a colon (":") separates entries. On Windows systems,
127 a semicolon (";") is used as a separator. The data dictionary code will
128 attempt to load each file specified in the \e DCMDICTPATH environment variable.
129 It is an error if no data dictionary can be loaded.
130 
131 \section files FILES
132 
133 <em><etcdir>/dcmpstat.cfg</em> - sample configuration file
134 
135 \section see_also SEE ALSO
136 
137 <b>dcmpsrcv</b>(1), <b>storescu</b>(1)
138 
139 \section copyright COPYRIGHT
140 
141 Copyright (C) 1998-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
142 
143 */


Generated on Wed Dec 28 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.8