DECOPY(1)

📦
version 0.3.2 · 4 versions
, in ubuntu stonking

💖 DECOPY 💖

okay bestie, sit down, because we're about to talk about the most iconic little helper for your debian/copyright files. her name is decopy and she's a General Commands Manual queen. 🌸

✨ NAME ✨

decopy — Automatic debian/copyright generator 🫶

✨ SYNTAX ✨

decopy [options] [files or dirs]

✨ DESCRIPTION ✨

So like, Decopy is a tool that automates creating and updating the debian/copyright files. No cap. 💅 She does this by parsing all files in a source tree, figuring out the copyright attribution and license for each file (when possible) and then structuring the output in the copyright format 1.0. literally doing the most so you don't have to. 👑

✨ USAGE ✨

Simply running decopy in the source tree that needs to be parsed will process all files in the tree, group them by license, wildcard those groups and generate the proper output to be written to the debian/copyright file. ✨

If the source tree already includes a debian/copyright file, it will be used as input for files where the license could not be inferred, for the copyright of the debian directory and for the license snippets. The license texts for well known licenses are filled in automatically (see --fill-licenses); any that are not recognised need to be filled in manually. 🙈

The files or directories specified as positional arguments can be used to limit the processing to the indicated subset instead of processing the complete source tree. 🎀

✨ EXAMPLES ✨

On top of the simple decopy usage, these examples show some of the most common usecases. Please see the following sections for detailed explanations of what each of the parameters do. 🦋

  • decopy --root src/hello-1.0/ --output src/hello-1.0/debian/copyright

This runs the parser in the hello-1.0 source tree and generates the debian/copyright file in the source tree (the debian/ directory needs to pre-exist this call). 👑

  • decopy --mode partial src/3rdparty/ninja

This shows the licensing and copyright information for the src/3rdparty/ninja directory. Only that directory is analyzed and the output includes only files contained in it. 🔍

  • decopy --group-by copyright

This processes the complete current source tree, paragraphs are split not only according to the licenses but also according to the copyright owners. 💖

  • decopy src

This will process the src directory but, provided debian/copyright already exists, show the complete updated debian/copyright file. ⭐

✨ COMMON OPTIONS ✨

these are the ones you'll actually use, bestie. 💅

  • --mode <mode> — Indicates the mode to use when generating the output. The full mode (default) will generate a complete debian/copyright file, even if only some files were processed (the rest of the contents are taken from the original debian/copyright file). The partial mode will only print the copyright and licensing information for the indicated files. The changed mode restricts processing to the files that changed since the debian/copyright file was last committed to git (see --changed and --since below).
  • --changed — Shorthand for --mode changed. Scopes the run to the files that changed since the debian/copyright file was last committed. This requires the source tree to be a git repository; if the changed set cannot be computed (git is not available, the tree is not a repository, or the copyright file is untracked) decopy warns and falls back to a full scan. 😭 (she'll still do the thing, just the long way)
  • --since <ref> — Baseline git ref for --changed. Defaults to the commit that last modified the debian/copyright file.
  • --output <file>, -o <file> — Store the generated output in the indicated file. This will overwrite the file if it already exists. ⚠️ like, overwrite. be aware.
  • --root <path> — Process the indicated path instead of the current directory. 🏠
  • --spdx, --no-spdx — When --spdx is given, license short names are rendered using their SPDX identifiers instead of the DEP-5 copyright format names. The default is --no-spdx, which uses the DEP-5 names.
  • --fill-licenses, --no-fill-licenses — When --fill-licenses (the default) is given, the License: stanzas in the generated output are filled in with the corresponding license text: a reference to /usr/share/common-licenses for the licenses shipped there, or the full text for other well known licenses. With --no-fill-licenses the license text is left as a TODO placeholder to be filled in manually. ✍️

✨ EXPLAIN MODE ✨

Instead of regenerating debian/copyright, decopy can report what is out of date in the existing file, which is useful as a check (e.g. in CI). 🧐 iconic behaviour honestly.

  • --explain — Report what is out of date in debian/copyright instead of regenerating it: stale Files paragraphs, patterns that no longer match any file, files whose license changed, new files that are not yet covered and copyright holders that have drifted. Nothing is written; decopy exits with status 1 if anything is stale and 0 if the file is up to date. 💀 (exit codes my beloved)

✨ GROUPING CRITERIA ✨

The generated output will always create separate paragraphs for groups of files with different licenses, additionally, it can also split paragraphs according to the following grouping options. 🌈

  • --group-by <criteria> — When grouping by license (default), all copyright owners of different files with the same license are listed together. When grouping by copyright, each different group of copyright owners is listed separatedly (files that have the exact same list of copyright owners are listed together).
  • --split-on-license — When a subdirectory has its own license file (COPYING, LICENSE, etc), the subdirectory is given its own paragraph, even if it has the same license as the main directory. This is the default.
  • --no-split-on-license — Even if a subdirectory has its own license file, the contents are listed together with other files in the tree that have the same license.
  • --split-debian — Even if the contents of the debian/ subdirectory have the same license as the main content, split it onto a separate paragraph. This is the default.
  • --no-split-debian — If the contents of the debian/ subdirectory have the same license as the main content, they are listed together.

✨ ARCHIVE EXPANSION ✨

Archive files (tar, zip and similar) found in the source tree are expanded and their contents are parsed as if they were regular files, so that licenses and copyright holders embedded inside archives are detected. 🦋✨

  • --expand-archives, --no-expand-archives — Enable or disable expanding archive files into their contents. Expansion is enabled by default (--expand-archives).
  • --max-archive-depth <n> — Maximum depth of nested archive expansion (archives contained inside other archives). Defaults to 1. 🌀
  • --max-archive-member-size <bytes> — Skip archive members larger than this many bytes. Defaults to 10 MB. 🐘

✨ LOG LEVEL OPTIONS ✨

The default logging shows WARN and ERROR messages. It can be modified with the following flags: 💬

  • --debug — Show DEBUG, INFO, WARN and ERROR messages. 🗣️
  • --verbose, -v — Show INFO, WARN and ERROR messages.
  • --quiet, -q — Show only ERROR messages. 🤫

✨ LESS COMMON OPTIONS ✨

these are the deep cuts, iykyk. 💜

  • --copyright-file <filename> — Specify a different copyright file to be used as a base for the processing. Defaults to debian/copyright
  • --text, -a — Parse all files as text files, instead of using the different parsers according to the file types (e.g. using exiftool for images). 🖼️
  • --jobs <n>, -j <n> — Number of jobs to run in parallel while processing files. Use 0 (the default) to pick a value automatically based on the available CPUs. ⚡
  • --glob, --no-glob — Enable or disable the use of glob (wildcard) patterns in the Files: field of the generated output. Globbing is enabled by default (--glob).
  • --progress, --no-progress — Show or hide the progress bar while processing files. The progress bar is shown by default (--progress). 📊
  • --exclude <path>, -X <path> — Exclude files from being parsed. The path can be specified as a regular expression that is matched against the full relative path for the file (e.g. -X '.*\.jpg$' to exclude all files that have the .jpg extension. or -X doc/ to exclude all files inside the doc/ directory). As a special case, debian/copyright and debian/changelog are always excluded.. 🚫
  • --gitignore, --no-gitignore — Honour the repository's ignore lists (.gitignore and .git/info/exclude) while walking the tree, so ignored files are not parsed. This is enabled by default (--gitignore); use --no-gitignore to parse ignored files too. This requires the pathspec module; without it the option has no effect. The Files-Excluded patterns from the header of an existing debian/copyright file are always honoured, regardless of this option. 🙅♀️

✨ COMPARISON WITH OTHER HELPERS ✨

Decopy was inspired by previous copyright helpers like copyright-helper by Modestas Vainius https://anonscm.debian.org/cgit/users/modax/copyright-helper.git/, licensecheck(1) by Jonas Smedegaard, or the copyright helper shipped with debmake(1), written by Osamu Aoki. 🌸

The main difference with all of them, is that decopy aims to detects as many licenses as possible, including many more that those in the other helpers, as well as the fact that it's capable of processing more than just plain text files. 💅

Additionally, while it is possible to use it for the creation of the copyright file, its main usecase is to keep the copyright file updated with any changes that are done to the source tree as time passes. ⏳ (she's a maintenance queen, not just a one-time thing)

✨ AUTHORS ✨

Decopy was written by Maximiliano Curia. The debian packaging and this manpage were created by Margarita Manterola. 🫶 king and queen behaviour.

Decopy and all the associated code and documentation are released under the ISC license. 📜

and that's the whole page, bestie! 🎀 this one's from July 2026, living in the General Commands Manual section, section 1 — go forth and let decopy handle your debian/copyright, you deserve it. ✨💖👑

📦 where this page comes from