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


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11