1/*!
2
3\if MANPAGES
4\page dcmprscp DICOM basic grayscale print management SCP
5\else
6\page dcmprscp dcmprscp: DICOM basic grayscale print management SCP
7\endif
8
9\section dcmprscp_synopsis SYNOPSIS
10
11\verbatim
12dcmprscp [options]
13\endverbatim
14
15\section dcmprscp_description DESCRIPTION
16
17The \b dcmprscp utility implements the DICOM Basic Grayscale Print Management
18Service Class as SCP. It also supports the optional Presentation LUT SOP
19Class.  The utility is intended for use within the DICOMscope viewer.
20
21The \b dcmprscp utility accepts print jobs from a remote Print SCU.  It does
22not create real hardcopies but stores print jobs in the local DICOMscope
23database as a set of Stored Print objects (one per page) and Hardcopy
24Grayscale images (one per film box N-SET).  The DICOMscope application allows
25to load a Stored Print object created by \b dcmprscp and to render a screen
26preview of the hardcopy.  The \b dcmprscp utility reads the characteristics of
27the printer to be emulated from the configuration file.
28
29\section dcmprscp_options OPTIONS
30
31\subsection dcmprscp_general_options general options
32\verbatim
33  -h   --help
34         print this help text and exit
35
36       --version
37         print version information and exit
38
39       --arguments
40         print expanded command line arguments
41
42  -q   --quiet
43         quiet mode, print no warnings and errors
44
45  -v   --verbose
46         verbose mode, print processing details
47
48  -d   --debug
49         debug mode, print debug information
50
51  -ll  --log-level  [l]evel: string constant
52         (fatal, error, warn, info, debug, trace)
53         use level l for the logger
54
55  -lc  --log-config  [f]ilename: string
56         use config file f for the logger
57
58  -l   --logfile
59         write a log file (not with --log-config)
60
61         # this option is available for reasons of backward
62         # compatibility only
63\endverbatim
64
65\subsection dcmprscp_processing_options processing options
66\verbatim
67  -c  --config  [f]ilename: string
68        process using settings from configuration file
69
70  -p  --printer  [n]ame: string (default: 1st printer in config file)
71        select printer with identifier n from config file
72
73  +d  --dump
74        dump all DIMSE messages
75\endverbatim
76
77\section dcmprscp_logging LOGGING
78
79The level of logging output of the various command line tools and underlying
80libraries can be specified by the user.  By default, only errors and warnings
81are written to the standard error stream.  Using option \e --verbose also
82informational messages like processing details are reported.  Option
83\e --debug can be used to get more details on the internal activity, e.g. for
84debugging purposes.  Other logging levels can be selected using option
85\e --log-level.  In \e --quiet mode only fatal errors are reported.  In such
86very severe error events, the application will usually terminate.  For more
87details on the different logging levels, see documentation of module "oflog".
88
89In case the logging output should be written to file (optionally with logfile
90rotation), to syslog (Unix) or the event log (Windows) option \e --log-config
91can be used.  This configuration file also allows for directing only certain
92messages to a particular output stream and for filtering certain messages
93based on the module or application where they are generated.  An example
94configuration file is provided in <em>\<etcdir\>/logger.cfg</em>.
95
96\section dcmprscp_command_line COMMAND LINE
97
98All command line tools use the following notation for parameters: square
99brackets enclose optional values (0-1), three trailing dots indicate that
100multiple values are allowed (1-n), a combination of both means 0 to n values.
101
102Command line options are distinguished from parameters by a leading '+' or '-'
103sign, respectively.  Usually, order and position of command line options are
104arbitrary (i.e. they can appear anywhere).  However, if options are mutually
105exclusive the rightmost appearance is used.  This behavior conforms to the
106standard evaluation rules of common Unix shells.
107
108In addition, one or more command files can be specified using an '@' sign as a
109prefix to the filename (e.g. <em>\@command.txt</em>).  Such a command argument
110is replaced by the content of the corresponding text file (multiple
111whitespaces are treated as a single separator unless they appear between two
112quotation marks) prior to any further evaluation.  Please note that a command
113file cannot contain another command file.  This simple but effective approach
114allows one to summarize common combinations of options/parameters and avoids
115longish and confusing command lines (an example is provided in file
116<em>\<datadir\>/dumppat.txt</em>).
117
118\section dcmprscp_environment ENVIRONMENT
119
120The \b dcmprscp utility will attempt to load DICOM data dictionaries specified
121in the \e DCMDICTPATH environment variable.  By default, i.e. if the
122\e DCMDICTPATH environment variable is not set, the file
123<em>\<datadir\>/dicom.dic</em> will be loaded unless the dictionary is built
124into the application (default for Windows).
125
126The default behavior should be preferred and the \e DCMDICTPATH environment
127variable only used when alternative data dictionaries are required.  The
128\e DCMDICTPATH environment variable has the same format as the Unix shell
129\e PATH variable in that a colon (":") separates entries.  On Windows systems,
130a semicolon (";") is used as a separator.  The data dictionary code will
131attempt to load each file specified in the \e DCMDICTPATH environment variable.
132It is an error if no data dictionary can be loaded.
133
134\section dcmprscp_files FILES
135
136<em>\<etcdir\>/dcmpstat.cfg</em>, <em>\<etcdir\>/printers.cfg</em> - sample configuration files
137
138\section dcmprscp_see_also SEE ALSO
139
140<b>dcmprscu</b>(1)
141
142\section dcmprscp_copyright COPYRIGHT
143
144Copyright (C) 1999-2014 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.
145
146*/
147