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

NAME

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

SYNOPSIS

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

DESCRIPTION

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

PARAMETERS

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

OPTIONS

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

NOTES

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

LOGGING

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

COMMAND LINE

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

ENVIRONMENT

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

SEE ALSO

121       dcmqrscp(1), dcmqrti(1)
122
124       Copyright  (C)  1993-2022  by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
125       Germany.
126
127
128
129Version 3.6.7                   Fri Apr 22 2022                    dcmqridx(1)
Impressum