1dcmqridx(1)                       OFFIS DCMTK                      dcmqridx(1)
2
3
4

NAME

6       dcmqridx - Register a DICOM image file in an image database index file
7

SYNOPSIS

9       dcmqridx [options] index-out [dcmfile-in...]
10

DESCRIPTION

12       The  dcmqridx ulility registers DICOM image files in the database index
13       file used by the dcmqrscp and dcmqrti applications. No image files  are
14       copied. dcmqridx can also list the contents of the database index file.
15

PARAMETERS

17       index-out   storage area for the index file (directory)
18
19       dcmfile-in  DICOM image file to be registered in the index file
20

OPTIONS

22         -h   --help
23                print this help text and exit
24
25              --version
26                print version information and exit
27
28              --arguments
29                print expanded command line arguments
30
31         -q   --quiet
32                quiet mode, print no warnings and errors
33
34         -v   --verbose
35                verbose mode, print processing details
36
37         -d   --debug
38                debug mode, print debug information
39
40         -ll  --log-level  [l]evel: string constant
41                (fatal, error, warn, info, debug, trace)
42                use level l for the logger
43
44         -lc  --log-config  [f]ilename: string
45                use config file f for the logger
46
47         -p   --print
48                list contents of database index file
49
50         -n   --not-new
51                set instance reviewed status to 'not new'
52

NOTES

54       dcmqridx  attempts  to  add  a reference to the database index file for
55       each image-file provided on the command line.
56
57       dcmqridx disables the database back-end quota system so that  no  image
58       files will be deleted.
59

LOGGING

61       The  level  of  logging  output  of  the various command line tools and
62       underlying libraries can be specified by the  user.  By  default,  only
63       errors  and  warnings  are  written to the standard error stream. Using
64       option --verbose also informational messages  like  processing  details
65       are  reported.  Option  --debug  can be used to get more details on the
66       internal activity, e.g. for debugging purposes.  Other  logging  levels
67       can  be  selected  using option --log-level. In --quiet mode only fatal
68       errors are reported. In such very severe error events, the  application
69       will  usually  terminate.  For  more  details  on the different logging
70       levels, see documentation of module 'oflog'.
71
72       In case the logging output should be written to file  (optionally  with
73       logfile  rotation),  to syslog (Unix) or the event log (Windows) option
74       --log-config can be used.  This  configuration  file  also  allows  for
75       directing  only  certain messages to a particular output stream and for
76       filtering certain messages based on the  module  or  application  where
77       they  are  generated.  An  example  configuration  file  is provided in
78       <etcdir>/logger.cfg).
79

COMMAND LINE

81       All command line tools  use  the  following  notation  for  parameters:
82       square  brackets  enclose  optional  values  (0-1), three trailing dots
83       indicate that multiple values are allowed (1-n), a combination of  both
84       means 0 to n values.
85
86       Command line options are distinguished from parameters by a leading '+'
87       or '-' sign, respectively. Usually, order and position of command  line
88       options  are  arbitrary  (i.e.  they  can appear anywhere). However, if
89       options are mutually exclusive the rightmost appearance is  used.  This
90       behaviour  conforms  to  the  standard  evaluation rules of common Unix
91       shells.
92
93       In addition, one or more command files can be specified  using  an  '@'
94       sign  as  a  prefix to the filename (e.g. @command.txt). Such a command
95       argument is replaced by the content  of  the  corresponding  text  file
96       (multiple  whitespaces  are  treated  as a single separator unless they
97       appear between two quotation marks) prior to  any  further  evaluation.
98       Please  note  that  a command file cannot contain another command file.
99       This  simple  but  effective  approach  allows  to   summarize   common
100       combinations  of  options/parameters  and  avoids longish and confusing
101       command lines (an example is provided in file <datadir>/dumppat.txt).
102

ENVIRONMENT

104       The dcmqridx utility will  attempt  to  load  DICOM  data  dictionaries
105       specified  in the DCMDICTPATH environment variable. By default, i.e. if
106       the  DCMDICTPATH  environment   variable   is   not   set,   the   file
107       <datadir>/dicom.dic  will be loaded unless the dictionary is built into
108       the application (default for Windows).
109
110       The  default  behaviour  should  be  preferred  and   the   DCMDICTPATH
111       environment  variable  only used when alternative data dictionaries are
112       required. The DCMDICTPATH environment variable has the same  format  as
113       the  Unix  shell PATH variable in that a colon (':') separates entries.
114       On Windows systems, a semicolon (';') is used as a separator. The  data
115       dictionary  code  will  attempt  to  load  each  file  specified in the
116       DCMDICTPATH environment variable. It is an error if no data  dictionary
117       can be loaded.
118

SEE ALSO

120       dcmqrscp(1), dcmqrti(1)
121
123       Copyright  (C)  1993-2010  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
124       Germany.
125
126
127
128Version 3.6.0                     6 Jan 2011                       dcmqridx(1)
Impressum