DH_INSTALLYORICK(1)

🎀 NAME 🎀

dh_installyorick — install Yorick add-on packages. (yes bestie, this is a Debhelper page, section 1, and it's about the skull-language guy 💀)

---

✨ SYNOPSIS ✨

dh_installyorick [debhelper options] [-m] [--no-make-install]

---

💅 DESCRIPTION 💅

okay so here's the tea 🍓: dh_installyorick is a debhelper program that drops all the files of your Yorick add-on in exactly the right place while you're building a Debian package. For a simple plug-in package, this is mostly just calling make DESTDIR=debian/<package> install and then yeeting the arch-independent files over to usr/share. And heads up, bestie: there is no Y_SITE/contrib directory in the Debian packages — its content is merged into YSITE/i. no cap.

Not feeling the make ... install vibe? You can turn it off with the --no-make-install flag. Super useful for interpreted add-on packages, which do not ship with a standard Yorick Makefile. 🧚

If the -m flag is used (but not the -n one), dh_installyorick will also add lines to your package's postinst and postrm scripts to call update-yorickdoc --auto if the yorick-doc package is installed. It is necessary to call dh_installdeb after dh_installyorick for this to work. It is usually not necessary with a recent dpkg supporting triggers, so this possibility is kept mostly for easing backports and should be deprecated soon. (it's giving "legacy era", we keep it for the backports girlies 🫶)

dh_installyorick will look for a file named debian/<package>.ynstall for additional files to install (peep the YNSTALL FILE section below 👇). The <package>. prefix can be omitted for the main binary package being built (usually the first one listed in debian/control).

For the time being, Y_SITE=Y_HOME=/usr/lib/yorick. Requests to install a file under Y_SITE result in its installation under /usr/share/yorick. dh_installyorick handles the creation of the necessary symbolic links from Y_HOME to /usr/share/yorick. 🔗

Files that are installed in a directory ending in /bin or /sbin, as well as files that are pointed at by symbolic link in such a directory, are installed with execution permission for everyone. chmod 755 energy, iconic 💅

---

👑 OPTIONS 👑

• -m — Modify postinst/postrm scripts to add a call to update-yorickdoc. This is needed only if the target dpkg does not support triggers. If both -m and -n are specified, the scripts are not modified. (-n said "not today" 🙈)
• --no-make-install — Do not call make DESTDIR=debian/<package> install.
• --infofile= — An additional pkg_mngr .info file to install.

---

Additionally, dh_installyorick abides by the following standard debhelper options: -a/--arch, -i/--indep, --mainpackage, -n, --no-act, -N/--no-package, -p/--package, -P/--tmpdir, -s/--same-arch, and -v/--verbose. the whole friend group showed up ✨

---

🦋 YNSTALL FILE 🦋

Blank lines are ignored, several blank characters are counted as one, and lines starting with # (possibly following one or more blanks) are ignored. so you can comment your lil heart out, bestie 💬 Each non-comment, non-blank line should be of the form:

file [directory [link]]

Where file is the file to install, directory the directory it should be installed in, and link an optional symbolic link pointing on the installed file.

🌸 file

the relative path from the top directory of the package source to the file. If link is not specified, file can contain shell globs and actually denote several files. If directory is not specified, it is guessed from the extension of file: .i files are installed in Y_SITE/i, .gs and .gp in Y_SITE/g, .info in Y_SITE/packages/installed, .packinfo, .aliases and .keywords in /usr/share/yorick-doc, and .so in Y_HOME/lib. autodetect? she ate 🔥

🌈 directory

the full path (without leading /) into which the file should be installed. If the file is to be installed inside Yorick's Y_SITE or Y_HOME directory (which will almost always be the case), it is possible (and advisable) to not specify the full path, but to write Y_SITE/ or Y_HOME followed by the relative path from there. It is also possible to omit this Y_SITE/ or Y_HOME/ prefix if directory starts whith one of: Y_SITE/i, Y_SITE/i0, Y_SITE/i-start, Y_SITE/g, Y_SITE/packages, Y_HOME/bin or Y_HOME/lib. shortcut queen 👑

💜 link

the full path to a symbolic link that should point to the installed file. The same shortcuts apply as for directory.

---

⭐ EXAMPLES ⭐

The four following lines in debian/ynstall would be equivalent:

somefile.i /usr/share/yorick/i
somefile.i Y_SITE/i
somefile.i i
somefile.i

Likewise, the following are equivalent:

somefile.i /usr/share/yorick/i0
somefile.i Y_SITE/i0
somefile.i i0

Example with a symlink. Here, somefile.i is a script that is both useful #included from within Yorick or from the command line. Its first line reads #!/usr/bin/yorick -batch. dual-threat script, main character energy fr fr 💖

somefile.i i usr/bin/command_name

---

🫶 SEE ALSO 🫶

debhelper(7), update-yorickdoc(1), deb-triggers(5)

This program is a part of yorick-dev but is made to work with debhelper. Note that only compatibility level 5 has been implemented and tested.

⚠️ okay this one's important, bestie: This script is not idempotent — dh_clean -k should be executed between any two runs. no skipping, iykyk. 😭

---

💖 AUTHORS 💖

Thibaut Paumard <paumard@users.sourceforge.net>

---

and that's the whole page, babes ✨ this lil slice of Debhelper knowledge is dated 2016-02-15, and yes, it's the DH_INSTALLYORICK(1) manual page — go install something cute 💅🎀🦋