MKJIGSNAP(8)

📦 version 1.22, in debian bookworm, debian trixie, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

MKJIGSNAP 💅 (section 8, System Manager's Manual)

okay so bestie, gather round, because mkjigsnap is about to become your new obsession 🫶

✨ NAME ✨

mkjigsnap — create a snapshot tree on a jigdo server 🌸

✨ SYNOPSIS ✨

mkjigsnap [OPTIONS] <-d snapshot_dir> <-j jigdo_file> <-k keyword> <-m
mirror> <-n CD_name> <-o output_directory> <-t template_file>
mkjigsnap [OPTIONS] <-b backref_file> <-d snapshot_dir> <-m mirror> <-J
jigdo_list> <-j jigdo_file> <-k keyword>

two whole modes, two whole vibes, pick your fighter 💖

✨ DESCRIPTION ✨

mkjigsnap makes snapshot directories for the other jigdo tools to snack on. it can run in two distinct modes, and no you cannot do both at once, pick a lane queen 👑

Jigit / single-jigdo mode 🎀

to build a jigit .conf file for one single jigdo file: throw the -n option on the command line with a CD name, and only specify a single jigdo to work with using -j. one jigdo. one file. main character energy, no sharing ✨

required arguments for this mode:

  • -d snapshot_dir — the output directory name for the snapshot tree (like 20041011, or rc1). in single-jigdo mode this is relative to the output directory. iykyk.
  • -j jigdo_file — where the jigdo file you wanna use lives.
  • -m mirror — where the mirror lives, i.e. the place holding all the files you need. ⚠️ this must be on the same filesystem as the output directory, because hard links get used to build the snapshot efficiently. no cap, same filesystem or it's over.
  • -n CD_name — the output name of the CD for jigit (like warty, or sarge-i386-1). name her and slay.
  • -o output_directory — where the jigdo, template, conf and snapshot all go. ⚠️ this must be on the same filesystem as the mirror, again because hard links are doing the efficient snapshot thing. bestie they have to be on the same filesystem, i'm literally begging you.
  • -t template_file — where the template file lives.

Multi-jigdo mode 🌈

to build a snapshot tree for (potentially multiple) jigdo files: do not use -n, and list as many jigdo files as you want — either right on the command line with multiple -j <jigdo> options, or (better, fr fr) via a file listing them with the -J option.

required arguments for this mode:

  • -d snapshot_dir — the output directory name for the snapshot tree (like 20041011, or rc1). yes same option, yes still iconic.
  • -J jigdo_list — a file listing the jigdo files to use. you can repeat this multiple times for multiple list files if you want to get fancy. ✨
  • -j jigdo_file — the jigdo file to use. may be repeated multiple times for multiple jigdo files, but honestly it's better to use -J and point at a file with a list of jigdo files instead. trust.
  • -k keyword — the "keywords" used inside the jigdo files (like Debian, Non-US, Ubuntu). 💜
  • -m mirror — where the mirror lives, holding all the files needed. ⚠️ must be on the same filesystem as the snapshot directory, because, say it with me, hard links are used to create the snapshot efficiently.

Options 🦋

optional arguments, and they work in both modes:

  • -b backref_file — if you're using a fail_log, also keep track of which jigdo files correspond to each missing file, and write those details out into the backref_file.
  • -f fail_log — if some files are required by the specific jigdo files but just are not available in the mirror, list them in the output file fail_log so you can check later. 🔥
  • -i ignore_list — if files are required by the specific jigdo files but aren't available in the mirror, list them in the ignore_list file to suppress errors about them. living in denial, but make it documented 💅

✨ EXAMPLES ✨

example one, the single-jigdo serve 👑
mkjigsnap -o /tmp/mjs-test -n mjs-test -m /tmp/mirror -j
       ~/jigdo/update/debian-update-3.0r2.01-i386.jigdo -t
       ~/jigdo/update/debian-update-3.0r2.01-i386.template -k Debian -k
       Non-US -d 20041017

this one is single-jigdo mode, used for Ubuntu jigit generation. it creates a single jigit conf file using the jigdo/template file pair you supplied, looking for jigdo references to files in the "Debian" and "Non-US" areas. it outputs the files into /tmp/mjs-test and calls them "mjs-test.<ext>", and it creates a snapshot of the needed files in /tmp/mjs-test/20041017 by linking files from /tmp/mirror as needed. ate and left no crumbs ✨

example two, the multi-jigdo serve 💖
mkjigsnap -m /org/ftp/debian -J ~/jigdo.list -k Debian
       -d /org/jigdo-area/snapshot/Debian -f ~/mkjigsnap-failed.log -i
       ~/mkjigsnap-ignore.list

this one is multi-jigdo mode, exactly as run to keep http://us.cdimage.debian.org/cdimage/snapshot/ up to date. it reads in all the jigdo files listed in ~/jigdo.list, building a list of every file referenced in the "Debian" area. then it attempts to build a snapshot tree of all those files under /org/jigdo-area/snapshot/Debian by linking from /org/ftp/debian. any files that are missing get listed into the output "missing" file ~/mkjigsnap-failed.log for later checking, UNLESS they're already listed in the "ignore" file ~/mkjigsnap-ignore.list. the way that works is genuinely so satisfying 😭

✨ SEE ALSO ✨

jigdo-file(1), jigit(1), jigdump(1) and mkimage(1). go read those next bestie, they're the rest of the friend group 🫶

Copyright 2004 - 2014 Steve McIntyre (steve@einval.com)

mkjigsnap may be copied under the terms and conditions of version 2 of the GNU General Public License, as published by the Free Software Foundation (Cambridge, MA, USA). 📜

✨ AUTHOR ✨

Written by Steve McIntyre (steve@einval.com) — king behavior 👑

mwah 💋 that's a wrap — this page comes to you from the Jigit jigdo tools, dated September 2004. periodt. 🎀

📦 where this page comes from