Add commands

Author: SimonSchubert

assets/commands/deda_anonmask_apply.md

@@ -0,0 +1,79 @@
+# TAGLINE
+
+Apply a tracking-dot mask to a PDF before printing
+
+# TLDR
+
+**Apply** a mask and write **masked.pdf**
+
+```deda_anonmask_apply [mask.json] [document.pdf]```
+
+Shift the pattern by a fraction of an **inch**
+
+```deda_anonmask_apply --xoffset [0.01] --yoffset [-0.02] [mask.json] [document.pdf]```
+
+Change the **dot radius**
+
+```deda_anonmask_apply --dotradius [0.005] [mask.json] [document.pdf]```
+
+Draw the dots in **magenta** so they are easy to see
+
+```deda_anonmask_apply --debug [mask.json] [document.pdf]```
+
+# SYNOPSIS
+
+**deda_anonmask_apply** [_options_] _mask_ _pdf_
+
+# PARAMETERS
+
+_mask_
+
+> Mask file written by **deda_anonmask_create -r**, usually **mask.json**.
+
+_pdf_
+
+> PDF to stamp. The original file is not modified.
+
+**--xoffset** _inches_, **--yoffset** _inches_
+
+> Extra horizontal and vertical shift of the dot grid, in inches.
+
+**--dotradius** _inches_
+
+> Radius of each dot, in inches. The default is the toolkit's built-in radius.
+
+**--debug**
+
+> Draw magenta dots instead of yellow ones.
+
+**-v**, **--verbose**
+
+> Repeat to print more diagnostic detail.
+
+# DESCRIPTION
+
+**deda_anonmask_apply** reads a mask from **deda_anonmask_create** and stamps that dot pattern onto a copy of a PDF. It prints the offset, dot radius, and scale it used, then writes **masked.pdf** in the working directory. Print that file with a zero page margin, the same margin used for the calibration page.
+
+Pages that contain white or light areas inside images need the **Wand** Python package, which binds to ImageMagick. Without it, those areas are left unmasked. The rest of the page is still processed.
+
+# CAVEATS
+
+The output path is always **masked.pdf** in the current directory. A file of that name is overwritten. The input PDF is not changed.
+
+Alignment depends on the printer using the same margin as the calibration print. **--xoffset**, **--yoffset**, and **--dotradius** are the adjustments when the grid does not cover the printer's own dots. A mask built with **deda_anonmask_create --copy** reproduces a pattern instead of hiding one.
+
+Yellow dots on a finished print are hard to see. **--debug** is the way to confirm placement before using yellow.
+
+# HISTORY
+
+**deda_anonmask_apply** is part of **DEDA**, written by **Timo Richter** and **Stephan Escher** and described in their **2018** paper on forensic analysis and anonymisation of printed documents.
+
+# SEE ALSO
+
+[deda_anonmask_create](/man/deda_anonmask_create)(1), [deda_create_dots](/man/deda_create_dots)(1), [deda_clean_document](/man/deda_clean_document)(1), [deda_parse_print](/man/deda_parse_print)(1)
+
+# RESOURCES
+
+```[Source code](https://github.com/dfd-tud/deda)```
+
+<!-- verified: 2026-10-06 -->

assets/commands/deda_anonmask_create.md

@@ -0,0 +1,67 @@
+# TAGLINE
+
+Build a calibration mask for printer tracking dots
+
+# TLDR
+
+**Write** the calibration page
+
+```deda_anonmask_create -w```
+
+**Read** a scan of that page and write the mask
+
+```deda_anonmask_create -r [calibration.png]```
+
+Copy the printer's dot pattern into the mask **instead of anonymising** it
+
+```deda_anonmask_create -r [calibration.png] --copy```
+
+# SYNOPSIS
+
+**deda_anonmask_create** **-w** [_options_]
+
+**deda_anonmask_create** **-r** _file_ [_options_]
+
+# PARAMETERS
+
+**-w**, **--write**
+
+> Write a calibration PDF to **testpage.pdf** in the working directory. Mutually exclusive with **-r**.
+
+**-r** _file_, **--read** _file_
+
+> Read a scan of a printed calibration page and write **mask.json**. Mutually exclusive with **-w**.
+
+**-c**, **--copy**
+
+> Store the printer's own dot pattern in the mask instead of an anonymising pattern. Used with **-r**.
+
+**-v**, **--verbose**
+
+> Repeat to print more diagnostic detail.
+
+# DESCRIPTION
+
+**deda_anonmask_create** is the first half of DEDA's print anonymisation. **-w** writes **testpage.pdf**. Print that file with no page margin, scan the printout at about **300** dpi in a lossless format, and pass the scan to **-r**. The command writes **mask.json**, which **deda_anonmask_apply** stamps onto later PDFs before they are printed.
+
+One of **-w** or **-r** is required. **--copy** makes the mask reproduce the dots the printer already prints, rather than a pattern meant to hide them.
+
+# CAVEATS
+
+**-w** always writes **testpage.pdf**, and **-r** always writes **mask.json**, both in the current directory. Existing files at those names are overwritten.
+
+The scan has to show the calibration dots. Margin scaling, a lossy format, or a driver that drops the yellow channel produces a mask that will not line up. **--copy** is a different operation from anonymisation: the printed page still carries a readable pattern.
+
+# HISTORY
+
+**deda_anonmask_create** is part of **DEDA**, written by **Timo Richter** and **Stephan Escher** and described in their **2018** paper on forensic analysis and anonymisation of printed documents.
+
+# SEE ALSO
+
+[deda_anonmask_apply](/man/deda_anonmask_apply)(1), [deda_parse_print](/man/deda_parse_print)(1), [deda_create_dots](/man/deda_create_dots)(1), [deda_clean_document](/man/deda_clean_document)(1)
+
+# RESOURCES
+
+```[Source code](https://github.com/dfd-tud/deda)```
+
+<!-- verified: 2026-10-06 -->

assets/commands/deda_clean_document.md

@@ -0,0 +1,61 @@
+# TAGLINE
+
+Remove yellow tracking dots from white areas of a scan
+
+# TLDR
+
+**Clean** a scan and write a new image
+
+```deda_clean_document [scan.png] [cleaned.png]```
+
+Also convert the result to **greyscale**
+
+```deda_clean_document --secure [scan.png] [cleaned.png]```
+
+# SYNOPSIS
+
+**deda_clean_document** [_options_] _input_ _output_
+
+# PARAMETERS
+
+_input_
+
+> Scan to read.
+
+_output_
+
+> File to write. The extension selects the output format.
+
+**-s**, **--secure**
+
+> Convert the cleaned image to greyscale.
+
+**-g**, **--grayscale**
+
+> Same as **--secure**.
+
+# DESCRIPTION
+
+**deda_clean_document** tries to remove yellow tracking dots from the white areas of a scanned page and writes the result to _output_. **--secure** (and its alias **--grayscale**) converts that result to greyscale, which drops the colour channel the dots are printed in.
+
+This operates on a scan. It does not change a PDF that is about to be printed. Covering dots on a new printout is the job of **deda_anonmask_create** and **deda_anonmask_apply**.
+
+# CAVEATS
+
+Dots that sit on top of a photograph or other non-white ink are outside what this command removes. Greyscale mode discards colour from the whole page, not only the dots.
+
+The command overwrites _output_ when that path already exists. It does not ask for confirmation.
+
+# HISTORY
+
+**deda_clean_document** is part of **DEDA**, written by **Timo Richter** and **Stephan Escher** and described in their **2018** paper on forensic analysis and anonymisation of printed documents.
+
+# SEE ALSO
+
+[deda_parse_print](/man/deda_parse_print)(1), [deda_anonmask_create](/man/deda_anonmask_create)(1), [deda_anonmask_apply](/man/deda_anonmask_apply)(1)
+
+# RESOURCES
+
+```[Source code](https://github.com/dfd-tud/deda)```
+
+<!-- verified: 2026-10-06 -->

assets/commands/deda_compare_prints.md

@@ -0,0 +1,59 @@
+# TAGLINE
+
+Compare tracking dots across scanned pages
+
+# TLDR
+
+**Compare** two scans
+
+```deda_compare_prints [page-a.png] [page-b.png]```
+
+Compare **every scan** in a set
+
+```deda_compare_prints [page1.png] [page2.png] [page3.png]```
+
+Set the scan **resolution**
+
+```deda_compare_prints -d [300] [page-a.png] [page-b.png]```
+
+# SYNOPSIS
+
+**deda_compare_prints** [_options_] _file_...
+
+# PARAMETERS
+
+_file_...
+
+> One or more scans. At least one path is required.
+
+**-d** _dpi_, **--dpi** _dpi_
+
+> Resolution of the scans. **0**, the default, asks the reader to detect it.
+
+**-v**, **--verbose**
+
+> Repeat to print more diagnostic detail.
+
+# DESCRIPTION
+
+**deda_compare_prints** reads the tracking-dot pattern on each scan and groups the files by the printer it detected. When every file resolves to the same printer, it prints **IDENTICAL**. Otherwise it prints how many printers it found, a manufacturer label for each group, and the paths in that group. Files it could not read are listed under **Errors**.
+
+The scans should be lossless and about **300** dpi, the same kind of input **deda_parse_print** expects.
+
+# CAVEATS
+
+A page with no detectable dots, or a pattern this toolkit does not know, shows up as an error or as its own group. That is not evidence that the printers differ. Pass **-d** when the image file does not store its resolution.
+
+# HISTORY
+
+**deda_compare_prints** is part of **DEDA**, written by **Timo Richter** and **Stephan Escher** and described in their **2018** paper on forensic analysis and anonymisation of printed documents.
+
+# SEE ALSO
+
+[deda_parse_print](/man/deda_parse_print)(1), [deda_extract_yd](/man/deda_extract_yd)(1), [deda_clean_document](/man/deda_clean_document)(1)
+
+# RESOURCES
+
+```[Source code](https://github.com/dfd-tud/deda)```
+
+<!-- verified: 2026-10-06 -->

assets/commands/deda_create_dots.md

@@ -0,0 +1,77 @@
+# TAGLINE
+
+Stamp a synthetic tracking-dot pattern onto a PDF
+
+# TLDR
+
+**Add** a dot pattern to a PDF
+
+```deda_create_dots [page.pdf]```
+
+Set the **serial** and **manufacturer** encoded in the dots
+
+```deda_create_dots --serial [123456] --manufacturer [Epson] [page.pdf]```
+
+Set the **timestamp** stored in the pattern
+
+```deda_create_dots --year [18] --month [11] --day [11] --hour [11] --minutes [11] [page.pdf]```
+
+Print the dots in **magenta** so they are easy to see
+
+```deda_create_dots --debug [page.pdf]```
+
+# SYNOPSIS
+
+**deda_create_dots** [_options_] _pdf_
+
+# PARAMETERS
+
+_pdf_
+
+> PDF the dots are added to. The original file is not modified.
+
+**--serial** _n_
+
+> Serial number encoded in the pattern. The default is **123456**.
+
+**--manufacturer** _name_
+
+> Manufacturer name encoded in the pattern. The default is **Epson**. The names this pattern accepts are **Xerox**, **Epson**, and **Dell**.
+
+**--year** _n_, **--month** _n_, **--day** _n_, **--hour** _n_, **--minutes** _n_
+
+> Timestamp fields encoded in the pattern. The defaults are year **18**, month **11**, day **11**, hour **11**, and minutes **11**.
+
+**--dotradius** _inches_
+
+> Radius of each dot, in inches. The default is the toolkit's built-in radius.
+
+**--debug**
+
+> Draw magenta dots instead of yellow ones.
+
+# DESCRIPTION
+
+**deda_create_dots** builds a tracking-dot matrix from the serial, manufacturer, and timestamp fields and stamps it onto a copy of a PDF. It prints the matrix, then writes **new_dots.pdf** in the working directory. The input PDF is left unchanged.
+
+**--debug** uses magenta so the added dots are visible without a microscope. The calibration page from **deda_anonmask_create -w** can be used as the input PDF.
+
+# CAVEATS
+
+The output path is always **new_dots.pdf** in the current directory. A file of that name is overwritten. There is no flag to choose another path.
+
+The manufacturer string has to be one the pattern tables include. An unknown name fails when the matrix is built. The year field is a two-digit value, matching the default of **18**.
+
+# HISTORY
+
+**deda_create_dots** is part of **DEDA**, written by **Timo Richter** and **Stephan Escher** and described in their **2018** paper on forensic analysis and anonymisation of printed documents.
+
+# SEE ALSO
+
+[deda_anonmask_create](/man/deda_anonmask_create)(1), [deda_anonmask_apply](/man/deda_anonmask_apply)(1), [deda_parse_print](/man/deda_parse_print)(1)
+
+# RESOURCES
+
+```[Source code](https://github.com/dfd-tud/deda)```
+
+<!-- verified: 2026-10-06 -->