OS Manuals

/usr/bin/dcmmkdir

DCMTK is a collection of libraries and applications implementing large parts the DICOM standard.

From dcmtk 3.7.1-r0 (os), captured 2026-11-05 by running dcmmkdir --help (exit 0). permalink

$dcmtk: dcmmkdir v3.7.1 2026-10-15 $

dcmmkdir: Create a DICOMDIR file
usage: dcmmkdir [options] [dcmfile-in...]

parameters:
  dcmfile-in                       ref. DICOM file (or directory to be scanned)

general options:
  -h      --help                   print this help text and exit
          --version                print version information and exit
          --arguments              print expanded command line arguments
  -q      --quiet                  quiet mode, print no warnings and errors
  -v      --verbose                verbose mode, print processing details
  -d      --debug                  debug mode, print debug information
  -ll     --log-level              [l]evel: string constant
                                   (fatal, error, warn, info, debug, trace)
                                   use level l for the logger
  -lc     --log-config             [f]ilename: string
                                   use config file f for the logger
input options:
  DICOMDIR identifiers:
    +F    --fileset-id             [i]d: string
                                   use specific file-set ID
                                   (default: DCMTK_MEDIA_DEMO, "" for none)
    +R    --descriptor             [f]ilename: string
                                   add a file-set descriptor file ID
                                   (e.g. README, default: no descriptor)
    +C    --char-set               [c]harset: string
                                   add a specific character set for descriptor
                                   (default: "ISO_IR 100" if descriptor present)
  reading:
    +id   --input-directory        [d]irectory: string
                                   read referenced DICOM files from directory d
                                   (default for --recurse: current directory)
    -m    --keep-filenames         expect filenames to be in DICOM format (def.)
    +m    --map-filenames          map to DICOM filenames (lowercase->uppercase,
                                   and remove trailing period)
    -r    --no-recurse             do not recurse within directories (default)
    +r    --recurse                recurse within filesystem directories
    +p    --pattern                [p]attern: string (only with --recurse)
                                   pattern for filename matching (wildcards)
processing options:
  consistency check:
    -W    --no-consistency-check   do not check files for consistency
    +W    --warn-inconsist-files   warn about inconsistent files (default)
    -a    --abort-inconsist-file   abort on first inconsistent file
  type 1 attributes:
    -I    --strict                 exit with error if DICOMDIR type 1 attributes
                                   are missing in DICOM file (default)
    +I    --invent                 invent DICOMDIR type 1 attributes
                                   if missing in DICOM file
    +Ipi  --invent-patient-id      invent new PatientID in case of inconsistent
                                   PatientName attributes
  other checks:
    +Nrs  --allow-retired-sop      allow retired SOP classes defined in previous
                                   editions of the DICOM standard
    -Nxc  --no-xfer-check          do not reject images with non-standard
                                   transfer syntax (just warn)
    -Nec  --no-encoding-check      do not reject images with non-standard
                                   pixel encoding (just warn)
    -Nrc  --no-resolution-check    do not reject images with non-standard
                                   spatial resolution (just warn)
  icon images:
    +X    --add-icon-image         add monochrome icon image on IMAGE level
                                   (default for cardiac profiles)
    -Xs   --icon-image-size        [s]ize: integer (1..128)
                                   width and height of the icon image (in pixel)
                                   (fixed: 128 for XA, 64 for CT/MR profile)
    -Xi   --icon-file-prefix       [p]refix: string
                                   use PGM image 'prefix'+'dcmfile-in' as icon
                                   (default: create icon from DICOM image)
    -Xd   --default-icon           [f]ilename: string
                                   use specified PGM image if icon cannot be
                                   created automatically (default: black image)
output options:
  DICOMDIR file:
    +D    --output-file            [f]ilename: string
                                   generate specific DICOMDIR file
                                   (default: DICOMDIR in current directory)
  profiles:
    -Pgp  --general-purpose        General Purpose Interchange on CD-R, DVD-RAM
                                   or BD Media (STD-GEN-CD/DVD-RAM/BD, default)
    -Pdv  --general-dvd-jpeg       General Purpose DVD Interchange with JPEG
                                   (STD-GEN-DVD-JPEG)
    -Pd2  --general-dvd-j2k        General Purpose DVD Interchange with JPEG
                                   2000 (STD-GEN-DVD-J2K)
    -Pbd  --general-bd-jpeg        General Purpose BD Interchange with JPEG
                                   (STD-GEN-BD-JPEG)
    -Pb2  --general-bd-j2k         General Purpose BD Interchange with JPEG
                                   2000 (STD-GEN-BD-J2K)
    -Pbm  --general-bd-mpeg2-mpml  General Purpose BD Interchange with MPEG2
                                   MP@ML (STD-GEN-BD-MPEG2-MPML)
    -Pbh  --general-bd-mpeg2-mphl  General Purpose BD Interchange with MPEG2
                                   MP@HL (STD-GEN-BD-MPEG2-MPHL)
    -Pba  --general-bd-mpeg4-hp    General Purpose BD Interchange with MPEG-4
                                   AVC/H.264 HiP@Level4.1
                                   (STD-GEN-BD-MPEG4-HPLV41)
    -Pbb  --general-bd-mpeg4-hpbd  General Purpose BD Interchange with MPEG-4
                                   AVC/H.264 BD-Compatible HiP@Level4.1
                                   (STD-GEN-BD-MPEG4-HPLV41BD)
          --general-bd-mpeg4-hp2d  General Purpose BD Interchange with MPEG-4
                                   AVC/H.264 HiP@Level4.2 for 2D video
                                   (STD-GEN-BD-MPEG4-HPLV42-2D)
          --general-bd-mpeg4-hp3d  General Purpose BD Interchange with MPEG-4
                                   AVC/H.264 HiP@Level4.2 for 3D video
                                   (STD-GEN-BD-MPEG4-HPLV42-3D)
          --general-bd-mpeg4-hpst  General Purpose BD Interchange with MPEG-4
                                   AVC/H.264 Stereo HiP@Level4.2
                                   (STD-GEN-BD-MPEG4-SHPLV42)
    -Pfl  --usb-and-flash-jpeg     General Purpose USB/Flash Memory Interchange
                                   with JPEG (STD-GEN-USB/MMC/CF/SD-JPEG)
    -Pf2  --usb-and-flash-j2k      General Purpose USB/Flash Memory Interchange
                                   with JPEG 2000 (STD-GEN-USB/MMC/CF/SD-J2K)
    -Pmi  --general-mime           General Purpose MIME Interchange
                                   (STD-GEN-MIME)
    -Pmp  --mpeg2-mpml-dvd         DVD Interchange with MPEG2 Main Profile @
                                   Main Level (STD-DVD-MPEG2-MPML)
    -Pbc  --basic-cardiac          Basic Cardiac X-Ray Angiographic Studies on
                                   CD-R Media (STD-XABC-CD)
    -Pxa  --xray-angiographic      1024 X-Ray Angiographic Studies on CD-R Media
                                   (STD-XA1K-CD)
    -Pxd  --xray-angiographic-dvd  1024 X-Ray Angiographic Studies on DVD Media
                                   (STD-XA1K-DVD)
    -Pde  --dental-radiograph      Dental Radiograph Interchange (STD-DEN-CD)
    -Pcm  --ct-and-mr              CT/MR Studies (STD-CTMR-xxxx)
    -Pus  --ultrasound-id-sf       Ultrasound Single Frame for Image Display
                                   (STD-US-ID-SF-xxxx)
          --ultrasound-sc-sf       Ultrasound Single Frame with Spatial
                                   Calibration (STD-US-SC-SF-xxxx)
          --ultrasound-cc-sf       Ultrasound Single Frame with Combined
                                   Calibration (STD-US-CC-SF-xxxx)
    -Pum  --ultrasound-id-mf       Ultrasound Single & Multi-Frame for Image
                                   Display (STD-US-ID-MF-xxxx)
          --ultrasound-sc-mf       Ultrasound Single & Multi-Frame with Spatial
                                   Calibration (STD-UD-SC-MF-xxxx)
          --ultrasound-cc-mf       Ultrasound Single & Multi-Frame with Combined
                                   Calibration (STD-UD-CC-MF-xxxx)
    -Pec  --12-lead-ecg            12-lead ECG Interchange on Diskette
                                   (STD-WVFM-ECG-FD)
    -Phd  --hemodynamic-waveform   Hemodynamic Waveform Interchange on Diskette
                                   (STD-WVFM-HD-FD)
  writing:
    -A    --replace                replace existing DICOMDIR (default)
    +A    --append                 append to existing DICOMDIR
    +U    --update                 update existing DICOMDIR
    -w    --discard                do not write out DICOMDIR
  backup:
          --create-backup          create a backup of existing DICOMDIR (def.)
    -nb   --no-backup              do not create a backup of existing DICOMDIR
  post-1993 value representations:
    +u    --enable-new-vr          enable support for new VRs (UN/UT) (default)
    -u    --disable-new-vr         disable support for new VRs, convert to OB
  group length encoding:
    -g    --group-length-remove    write without group length elements (default)
    +g    --group-length-create    write with group length elements
  length encoding in sequences and items:
    +e    --length-explicit        write with explicit lengths (default)
    -e    --length-undefined       write with undefined lengths
Options (55)
OptionDescriptionSource
-h--help print this help text and exithelp
--versionprint version information and exithelp
--argumentsprint expanded command line argumentshelp
-q--quiet quiet mode, print no warnings and errorshelp
-v--verbose verbose mode, print processing detailshelp
-d--debug debug mode, print debug informationhelp
-ll--log-level [l]evel: string constant (fatal, error, warn, info, debug, trace) use level l for the loggerhelp
-lc--log-config [f]ilename: string use config file f for the loggerhelp
-m--keep-filenames expect filenames to be in DICOM format (def.)help
-r--no-recurse do not recurse within directories (default)help
-W--no-consistency-check do not check files for consistencyhelp
-a--abort-inconsist-file abort on first inconsistent filehelp
-I--strict exit with error if DICOMDIR type 1 attributes are missing in DICOM file (default)help
-Nxc--no-xfer-check do not reject images with non-standard transfer syntax (just warn)help
-Nec--no-encoding-check do not reject images with non-standard pixel encoding (just warn)help
-Nrc--no-resolution-check do not reject images with non-standard spatial resolution (just warn)help
-Xs--icon-image-size [s]ize: integer (1..128) width and height of the icon image (in pixel) (fixed: 128 for XA, 64 for CT/MR profile)help
-Xi--icon-file-prefix [p]refix: string use PGM image 'prefix'+'dcmfile-in' as icon (default: create icon from DICOM image)help
-Xd--default-icon [f]ilename: string use specified PGM image if icon cannot be created automatically (default: black image)help
-Pgp--general-purpose General Purpose Interchange on CD-R, DVD-RAM or BD Media (STD-GEN-CD/DVD-RAM/BD, default)help
-Pdv--general-dvd-jpeg General Purpose DVD Interchange with JPEG (STD-GEN-DVD-JPEG)help
-Pd2--general-dvd-j2k General Purpose DVD Interchange with JPEG 2000 (STD-GEN-DVD-J2K)help
-Pbd--general-bd-jpeg General Purpose BD Interchange with JPEG (STD-GEN-BD-JPEG)help
-Pb2--general-bd-j2k General Purpose BD Interchange with JPEG 2000 (STD-GEN-BD-J2K)help
-Pbm--general-bd-mpeg2-mpml General Purpose BD Interchange with MPEG2 MP@ML (STD-GEN-BD-MPEG2-MPML)help
-Pbh--general-bd-mpeg2-mphl General Purpose BD Interchange with MPEG2 MP@HL (STD-GEN-BD-MPEG2-MPHL)help
-Pba--general-bd-mpeg4-hp General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41)help
-Pbb--general-bd-mpeg4-hpbd General Purpose BD Interchange with MPEG-4 AVC/H.264 BD-Compatible HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41BD)help
--general-bd-mpeg4-hp2dGeneral Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 2D video (STD-GEN-BD-MPEG4-HPLV42-2D)help
--general-bd-mpeg4-hp3dGeneral Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 3D video (STD-GEN-BD-MPEG4-HPLV42-3D)help
--general-bd-mpeg4-hpstGeneral Purpose BD Interchange with MPEG-4 AVC/H.264 Stereo HiP@Level4.2 (STD-GEN-BD-MPEG4-SHPLV42)help
-Pfl--usb-and-flash-jpeg General Purpose USB/Flash Memory Interchange with JPEG (STD-GEN-USB/MMC/CF/SD-JPEG)help
-Pf2--usb-and-flash-j2k General Purpose USB/Flash Memory Interchange with JPEG 2000 (STD-GEN-USB/MMC/CF/SD-J2K)help
-Pmi--general-mime General Purpose MIME Interchange (STD-GEN-MIME)help
-Pmp--mpeg2-mpml-dvd DVD Interchange with MPEG2 Main Profile @ Main Level (STD-DVD-MPEG2-MPML)help
-Pbc--basic-cardiac Basic Cardiac X-Ray Angiographic Studies on CD-R Media (STD-XABC-CD)help
-Pxa--xray-angiographic 1024 X-Ray Angiographic Studies on CD-R Media (STD-XA1K-CD)help
-Pxd--xray-angiographic-dvd 1024 X-Ray Angiographic Studies on DVD Media (STD-XA1K-DVD)help
-Pde--dental-radiograph Dental Radiograph Interchange (STD-DEN-CD)help
-Pcm--ct-and-mr CT/MR Studies (STD-CTMR-xxxx)help
-Pus--ultrasound-id-sf Ultrasound Single Frame for Image Display (STD-US-ID-SF-xxxx)help
--ultrasound-sc-sfUltrasound Single Frame with Spatial Calibration (STD-US-SC-SF-xxxx)help
--ultrasound-cc-sfUltrasound Single Frame with Combined Calibration (STD-US-CC-SF-xxxx)help
-Pum--ultrasound-id-mf Ultrasound Single & Multi-Frame for Image Display (STD-US-ID-MF-xxxx)help
--ultrasound-sc-mfUltrasound Single & Multi-Frame with Spatial Calibration (STD-UD-SC-MF-xxxx)help
--ultrasound-cc-mfUltrasound Single & Multi-Frame with Combined Calibration (STD-UD-CC-MF-xxxx)help
-Pec--12-lead-ecg 12-lead ECG Interchange on Diskette (STD-WVFM-ECG-FD)help
-Phd--hemodynamic-waveform Hemodynamic Waveform Interchange on Diskette (STD-WVFM-HD-FD)help
-A--replace replace existing DICOMDIR (default)help
-w--discard do not write out DICOMDIRhelp
--create-backupcreate a backup of existing DICOMDIR (def.)help
-nb--no-backup do not create a backup of existing DICOMDIRhelp
-u--disable-new-vr disable support for new VRs, convert to OBhelp
-g--group-length-remove write without group length elements (default)help
-e--length-undefined write with undefined lengthshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.