.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH DICOMFIND "1" "February 2024" "dicomfind 0.8.14" "User Commands"
.SH NAME
dicomfind \- vtk-dicom CLI
.SH DESCRIPTION
.SS "usage:"
.IP
dicomfind [options] <directory> ...
.SS "options:"
.TP
\fB\-L\fR
Follow symbolic links (default).
.TP
\fB\-P\fR
Do not follow symbolic links.
.TP
\fB\-k\fR tag=value
Provide an attribute to be queried and matched.
.TP
\fB\-q\fR <query.txt>
Provide a file to describe the find query.
.TP
\fB\-u\fR <uids.txt>
Provide a file that contains a list of UIDs.
.TP
\fB\-maxdepth\fR n
Set the maximum directory depth.
.TP
\fB\-name\fR pattern
Set a pattern to match (with "*" or "?").
.TP
\fB\-image\fR
Restrict the search to files with PixelData.
.TP
\fB\-series\fR
Find all files in series if even one file matches.
.TP
\fB\-print\fR
Print the filenames of all matched files (default).
.TP
\fB\-print0\fR
Print the filenames with terminating null, for xargs.
.TP
\fB\-exec\fR ... +
Execute the given command for every series matched.
.TP
\fB\-exec\fR ... \e;
Execute the given command for every file matched.
.TP
\fB\-execdir\fR ... +
Go to directory and execute command on every series.
.TP
\fB\-execdir\fR ... \e;
Go to directory and execute command on every file.
.TP
\fB\-\-directory\-only\fR
Do not scan files themselves if DICOMDIR is present.
.HP
\fB\-\-ignore\-dicomdir\fR Ignore the DICOMDIR file even if it is present.
.TP
\fB\-\-charset\fR <cs>
Charset to use if SpecificCharacterSet is missing.
.TP
\fB\-\-help\fR
Print a brief help message.
.TP
\fB\-\-version\fR
Print the software version.
.PP
This command can be used to locate DICOM files.  It shares many
features with the UNIX "find" command.  When searching for files
with a specific attribute (with "\-k"), the tag can be specified
in the form GGGG,EEEE or with its canonical name e.g. Modality=MR
from the DICOM dictionary.  Alternately, the tags can be listed in a
query file given with the "\-q" option (one tag per line).
Attributes nested within sequences can be specified by giving a tag
path e.g. "\-k Tag1/Tag2/Tag3".  Either a forward slash or a backslash
can be used to separate the components of the path.  Private tags
should be preceded by the private dictionary name in square brackets.
.PP
The "\-exec" and "\-execdir" arguments cause dicomfind to run the
specified program on the found files.  For example, to dump each file
one would use "\-exec dicomdump {} \e;" where each instance of {} will
be replaced by a found file, and ";" indicates the end of the args
to dicomdump.  Alternately, if "+" is used to end the args, then the
program will be run on each DICOM series and {} will be replaced by all
files in the series.  The "\-execdir" argument is similar, except that
it runs the program from within the directory of the file (or files),
and {} is replaced by just the filenames instead of with the full paths.
.SH AUTHOR
This  manual  page was written by Mathieu Malaterre <malat@debian.org> for
the Debian GNU/Linux system, but may be used by others.