Arch::Tarball(3pm)

💖 Arch::Tarball 💖

okay so bestie, this is the Arch::Tarball page from the User Contributed Perl Documentation — yes, a whole module for making and poking at tarballs, and honestly? iconic.

---

✨ NAME ✨

Arch::Tarball — it's an interface to create and work with tarballs 🎀

---

🌸 SYNOPSIS 🌸

use Arch::Tarball

my $tarball = Arch::Tarball->new;
my $pipe = $tarball->create(
    dir => '/path/to/subdir-to-pack',
    base_name => 'new-subdir-to-pack',
    pipe => 1,
);

look at her go 💅

---

🦋 DESCRIPTION 🦋

Arch::Tarball gives you an object oriented interface to work with standard gzipped tarballs — like, to create, examine or extract them. three whole moods.

note: functionality only gets added when it's needed, so a lot of features are currently not implemented. she's a work in progress, and we respect that 🙈

---

👑 METHODS 👑

The following functions are available:

new, create, extract, list.

💜 new %opts

Creates a new Arch::Tarball object. new object, new me ✨

The following parameters can be set via %opts:

• tar — the name of the tar executable. Defaults to "tar".
• file — the filename of the Tarball.

🌈 create %opts

Creates a new tarball (tar.gz) from a given directory structure. packing it UP 🎀

create understands the following options:

• dir (mandatory) — specifies the base directory for the tarball. The given directory and recursively its content will be added to the tarball. The directory's basename will be used as the first and the only subdirectory in the tarball. mandatory bestie, do not skip her 💀
• base_name — lets the programmer specify a different base directory name for the tarball content than the basename of dir. In this case, a 'cp' process is launched to temporarily rename the last element of dir. sneaky little rename moment.
• pipe — when set, create does not create a physical tarball but writes the tarball's content to a newly created pipe. The pipe is returned by the create method. so she hands you the pipe directly, no middleman 🫶

note: currently the pipe option is mandatory. like, not optional. mandatory mandatory.

🧚 extract %opts

Extracts the tarball to a given target directory, specified by the dir option. If the dir option is not given, a temporary directory is created that will hold the extracted dirs/files. This directory is returned. unpacking szn 💖

The file option specifies the tarball file name. It may be given in the constructor instead — your call, either vibe works.

🍓 list %opts (not implemented yet)

Returns a list of files and directories in the tarball. one day, bestie. one day 😭

---

💀 BUGS 💀

Most functionality is currently not implemented. If you need part of the missing functionality, please contact the authors.

Patches are greatly appreciated. fr fr, send the patch, be the main character 🙏

---

💅 AUTHORS 💅

Mikhael Goikhman (migo@homemail.com--Perl-GPL/arch-perl--devel).

Enno Cramer (uebergeek@web.de--2003/arch-perl--devel).

---

and that's the whole page, bestie 🎀 no cap. this one's from perl v5.20.2, dated 2005-04-22 — vintage, honestly, and still serving. go make a tarball. slay 💖✨🦋