1dcm2pdf(1) OFFIS DCMTK dcm2pdf(1)
2
6 dcm2pdf - Extract PDF file from DICOM encapsulated PDF
7
9 dcm2pdf [options] dcmfile-in pdffile-out
10
12 The dcm2pdf utility reads a DICOM file of the Encapsulated PDF Storage
13 SOP Class (dcmfile-in), extracts the embedded PDF document and writes
14 it to an output file (pdffile-out). Optionally a command can be
15 executed after the creation of the PDF file.
16
18 dcmfile-in DICOM input filename
19 pdffile-out PDF output filename
21
23 general options
24 -h --help
25 print this help text and exit
26 --version
28 print version information and exit
29 --arguments
31 print expanded command line arguments
32 -q --quiet
34 quiet mode, print no warnings and errors
35 -v --verbose
37 verbose mode, print processing details
38 -d --debug
40 debug mode, print debug information
41 -ll --log-level [l]evel: string constant
43 (fatal, error, warn, info, debug, trace)
44 use level l for the logger
45 -lc --log-config [f]ilename: string
47 use config file f for the logger
48 input options
50 input file format:
51 +f --read-file
53 read file format or data set (default)
54 +fo --read-file-only
56 read file format only
57 -f --read-dataset
59 read data set without file meta information
60 input transfer syntax:
62 -t= --read-xfer-auto
64 use TS recognition (default)
65 -td --read-xfer-detect
67 ignore TS specified in the file meta header
68 -te --read-xfer-little
70 read with explicit VR little endian TS
71 -tb --read-xfer-big
73 read with explicit VR big endian TS
74 -ti --read-xfer-implicit
76 read with implicit VR little endian TS
77 parsing of odd-length attributes:
79 +ao --accept-odd-length
81 accept odd length attributes (default)
82 +ae --assume-even-length
84 assume real length is one byte larger
85 handling of undefined length UN elements:
87 +ui --enable-cp246
89 read undefined len UN as implicit VR (default)
90 -ui --disable-cp246
92 read undefined len UN as explicit VR
93 handling of defined length UN elements:
95 -uc --retain-un
97 retain elements as UN (default)
98 +uc --convert-un
100 convert to real VR if known
101 automatic data correction:
103 +dc --enable-correction
105 enable automatic data correction (default)
106 -dc --disable-correction
108 disable automatic data correction
109 bitstream format of deflated input:
111 +bd --bitstream-deflated
113 expect deflated bitstream (default)
114 +bz --bitstream-zlib
116 expect deflated zlib bitstream
117 execution options
119 -x --exec [c]ommand: string
120 execute command c after PDF extraction
121
123 Option --exec allows for the execution of a certain command line after
124 the creation of the PDF document. The command line to be executed is
125 passed to this option as a parameter. The specified command line may
126 contain the placeholder '#f', which will be replaced by the PDF
127 filename at run time. The specified command line is executed in the
128 foreground, i.e. pdf2dcm will be blocked until the command terminates.
129
131 The level of logging output of the various command line tools and
132 underlying libraries can be specified by the user. By default, only
133 errors and warnings are written to the standard error stream. Using
134 option --verbose also informational messages like processing details
135 are reported. Option --debug can be used to get more details on the
136 internal activity, e.g. for debugging purposes. Other logging levels
137 can be selected using option --log-level. In --quiet mode only fatal
138 errors are reported. In such very severe error events, the application
139 will usually terminate. For more details on the different logging
140 levels, see documentation of module 'oflog'.
141 In case the logging output should be written to file (optionally with
143 logfile rotation), to syslog (Unix) or the event log (Windows) option
144 --log-config can be used. This configuration file also allows for
145 directing only certain messages to a particular output stream and for
146 filtering certain messages based on the module or application where
147 they are generated. An example configuration file is provided in
148 <etcdir>/logger.cfg).
149
151 All command line tools use the following notation for parameters:
152 square brackets enclose optional values (0-1), three trailing dots
153 indicate that multiple values are allowed (1-n), a combination of both
154 means 0 to n values.
155 Command line options are distinguished from parameters by a leading '+'
157 or '-' sign, respectively. Usually, order and position of command line
158 options are arbitrary (i.e. they can appear anywhere). However, if
159 options are mutually exclusive the rightmost appearance is used. This
160 behaviour conforms to the standard evaluation rules of common Unix
161 shells.
162 In addition, one or more command files can be specified using an '@'
164 sign as a prefix to the filename (e.g. @command.txt). Such a command
165 argument is replaced by the content of the corresponding text file
166 (multiple whitespaces are treated as a single separator unless they
167 appear between two quotation marks) prior to any further evaluation.
168 Please note that a command file cannot contain another command file.
169 This simple but effective approach allows to summarize common
170 combinations of options/parameters and avoids longish and confusing
171 command lines (an example is provided in file <datadir>/dumppat.txt).
172
174 The dcm2pdf utility will attempt to load DICOM data dictionaries
175 specified in the DCMDICTPATH environment variable. By default, i.e. if
176 the DCMDICTPATH environment variable is not set, the file
177 <datadir>/dicom.dic will be loaded unless the dictionary is built into
178 the application (default for Windows).
179 The default behaviour should be preferred and the DCMDICTPATH
181 environment variable only used when alternative data dictionaries are
182 required. The DCMDICTPATH environment variable has the same format as
183 the Unix shell PATH variable in that a colon (':') separates entries.
184 On Windows systems, a semicolon (';') is used as a separator. The data
185 dictionary code will attempt to load each file specified in the
186 DCMDICTPATH environment variable. It is an error if no data dictionary
187 can be loaded.
188
190 pdf2dcm(1)
191
193 Copyright (C) 2007-2010 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
194 Germany.
195Version 3.6.0 6 Jan 2011 dcm2pdf(1)