4 \page dcmprscu Print spooler for presentation state viewer
6 \page dcmprscu dcmprscu: Print spooler for presentation state viewer
9 \section synopsis SYNOPSIS
12 dcmprscu [options] [dcmfile-in...]
15 \section description DESCRIPTION
17 The \b dcmprscu utility implements the DICOM Basic Grayscale Print Management
18 Service Class as SCU. It also supports the optional Basic Annotation Box
19 and Presentation LUT SOP Classes. The utility is intended for use within
20 the DICOMscope viewer.
22 The \b dcmprscu utility takes complete print jobs consisting of a Stored Print
23 object and one or more Hardcopy Grayscale objects and spools them to the
24 printer. No attempt is made to check whether the attributes defined in the
25 Stored Print object are supported by the Print SCP. However, the print
26 spooler will not attempt to use the optional Annotation or Presentation LUT
27 services if they are not successfully negotiated with the Print SCP.
29 The \b dcmprscu utility reads the characteristics of the printer to
30 communicate with from the configuration file. Depending on the printer's
31 support for Presentation LUT, any Presentation LUT present in the print job
32 will be rendered into the hardcopy images before they are spooled to the
33 printer if necessary. If the printer does not support image transmission
34 with 12 bits/pixel (as per the configuration file), the grayscale hardcopy
35 images are down-sampled to 8 bits/pixel before transmission to the printer.
37 The \b dcmprscu utility can be run either in "printer mode", in which case
38 the file name of a Stored Print object must be passed, or in "spool mode",
39 in which case commands are read periodically from a spool directory.
41 \section parameters PARAMETERS
44 dcmfile-in stored print file(s) to be spooled
47 \section options OPTIONS
49 \subsection general_options general options
52 print this help text and exit
55 print version information and exit
58 print expanded command line arguments
61 quiet mode, print no warnings and errors
64 verbose mode, print processing details
67 debug mode, print debug information
69 -ll --log-level [l]evel: string constant
70 (fatal, error, warn, info, debug, trace)
71 use level l for the logger
73 -lc --log-config [f]ilename: string
74 use config file f for the logger
77 \subsection print_options print options
80 do not create print-out (no n-action-rq)
83 send film session n-action-rq (instead of film box)
86 transmit basic grayscale images in MONOCHROME1
89 \subsection mode_options mode options
92 printer mode, print file(s) and terminate (default)
94 +s --spool [n]ame: string
95 spooler mode, use job prefix n
98 \subsection processing_options processing options
100 -c --config [f]ilename: string
101 process using settings from configuration file
103 -p --printer [n]ame: string (default: 1st printer in cfg file)
104 select printer with identifier n from cfg file
107 dump all DIMSE messages
110 \subsection spooler_options spooler options (only with --spool)
112 --sleep [d]elay: integer (default: 1)
113 sleep d seconds between spooler checks
116 \subsection film_session_options basic film session options (not with --spool):
118 --copies [v]alue: integer (1..100, default: 1)
119 set number of copies to v
121 --medium-type [v]alue: string
124 --destination [v]alue: string
125 set film destination to v
127 --label [v]alue: string
128 set film session label to v
130 --priority [v]alue: string
131 set print priority to v
133 --owner [v]alue: string
134 set film session owner ID to v
137 \section logging LOGGING
139 The level of logging output of the various command line tools and underlying
140 libraries can be specified by the user. By default, only errors and warnings
141 are written to the standard error stream. Using option \e --verbose also
142 informational messages like processing details are reported. Option
143 \e --debug can be used to get more details on the internal activity, e.g. for
144 debugging purposes. Other logging levels can be selected using option
145 \e --log-level. In \e --quiet mode only fatal errors are reported. In such
146 very severe error events, the application will usually terminate. For more
147 details on the different logging levels, see documentation of module "oflog".
149 In case the logging output should be written to file (optionally with logfile
150 rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
151 can be used. This configuration file also allows for directing only certain
152 messages to a particular output stream and for filtering certain messages
153 based on the module or application where they are generated. An example
154 configuration file is provided in <em><etcdir>/logger.cfg</em>).
156 \section command_line COMMAND LINE
158 All command line tools use the following notation for parameters: square
159 brackets enclose optional values (0-1), three trailing dots indicate that
160 multiple values are allowed (1-n), a combination of both means 0 to n values.
162 Command line options are distinguished from parameters by a leading '+' or '-'
163 sign, respectively. Usually, order and position of command line options are
164 arbitrary (i.e. they can appear anywhere). However, if options are mutually
165 exclusive the rightmost appearance is used. This behaviour conforms to the
166 standard evaluation rules of common Unix shells.
168 In addition, one or more command files can be specified using an '@' sign as a
169 prefix to the filename (e.g. <em>\@command.txt</em>). Such a command argument
170 is replaced by the content of the corresponding text file (multiple
171 whitespaces are treated as a single separator unless they appear between two
172 quotation marks) prior to any further evaluation. Please note that a command
173 file cannot contain another command file. This simple but effective approach
174 allows to summarize common combinations of options/parameters and avoids
175 longish and confusing command lines (an example is provided in file
176 <em><datadir>/dumppat.txt</em>).
178 \section environment ENVIRONMENT
180 The \b dcmprscu utility will attempt to load DICOM data dictionaries specified
181 in the \e DCMDICTPATH environment variable. By default, i.e. if the
182 \e DCMDICTPATH environment variable is not set, the file
183 <em><datadir>/dicom.dic</em> will be loaded unless the dictionary is built
184 into the application (default for Windows).
186 The default behaviour should be preferred and the \e DCMDICTPATH environment
187 variable only used when alternative data dictionaries are required. The
188 \e DCMDICTPATH environment variable has the same format as the Unix shell
189 \e PATH variable in that a colon (":") separates entries. On Windows systems,
190 a semicolon (";") is used as a separator. The data dictionary code will
191 attempt to load each file specified in the \e DCMDICTPATH environment variable.
192 It is an error if no data dictionary can be loaded.
196 <em><etcdir>/dcmpstat.cfg</em>, <em><etcdir>/printers.cfg</em> - sample configuration files
198 \section see_also SEE ALSO
202 \section copyright COPYRIGHT
204 Copyright (C) 1999-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.