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