Sys::F...m::Unix(3pm)

📦 version 1.408, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Sys::Filesystem::Unix 💖

okay so bestie, welcome to Sys::Filesystem::Unix(3pm) — the little Perl module that goes out and gets you the generic Unix filesystem tea and hands it right over to Sys::Filesystem. it's giving backstage-pass-to-your-own-hard-drive energy, and honestly? we're obsessed. 🦋

✨ NAME ✨

Sys::Filesystem::Unix — returns generic Unix filesystem information to Sys::Filesystem. that's it, that's the whole job, and she does it flawlessly. periodt. 💅

🌸 SYNOPSIS 🌸

like, go look at Sys::Filesystem. that's where the party's at. 👑

See Sys::Filesystem.

🎀 INHERITANCE 🎀

the family tree, lowkey:

  Sys::Filesystem::Unix
  ISA UNIVERSAL

so yeah, she's a UNIVERSAL girlie. iconic behaviour, no cap. 💜

⭐ METHODS ⭐

🌈 version()

returns the version of the (sub)module. short, sweet, main character energy. ✨

🍓 readFsTab

this method provides the capability to parse a standard unix fstab file. she read the fstab so you don't have to. 🫶

she expects following arguments:

  • fstabPath — full qualified path to the fstab file to read. like, the whole path, bestie, don't be vague. 📁
  • fstabKeys — the column names for the fstab file through an array reference.
  • special_fs — hash reference containing the names of all special file systems having a true value as key.

this method returns true in case the specified file could be opened for reading, false otherwise. so like, true = slay, false = 💀.

🧚 readMntTab

this method provides the capability to read abd parse a standard unix mount-tab file. the file is locked using flock after opening it. 🔒 yes she's locked in, literally and figuratively.

it expects following arguments:

  • mnttabPath — full qualified path to the mnttab file to read.
  • mnttabKeys — the column names for the mnttab file through an array reference.
  • $special_fs — hash reference containing the names of all special file systems having a true value as key. (yes, with the sigil this time. she's fancy. 💅)

this method returns true in case the specified file could be opened for reading and locked, false otherwise.

🔥 readMounts

this method is called to parse the information got from "mount" system command. she's reading the receipts from mount herself. it expects following arguments:

  • mount_rx — regular expression to extract the information from each mount line.
  • pridx — array reference containing the index for primary keys of interest in match in following order: device, mount_point, type.
  • keys — array reference of the columns of the match — in order of paranteses in regular expression.
  • special — array reference containing the names of the special file system types.
  • lines — array containing the lines to parse.

💜 readSwap

this method is called to parse the information from the swap status. it expects following arguments:

  • swap_rx — regular expression to extract the information from each swap status line. this regular expression should have exact one pair of parantheses to identify the swap device. ⚠️ like, exactly one pair, bestie — not two, not zero. one. don't test her.
  • lines — array containing the lines to parse.

👑 AUTHOR 👑

two absolute legends, fr fr. 🌟

Copyright 2004,2005,2006 Nicola Worthington.

Copyright 2008-2020 Jens Rehsack.

This software is licensed under The Apache Software License, Version 2.0.

<http://www.apache.org/licenses/LICENSE-2.0>

legal stuff bestie, we don't make the rules, we just cite them. 📜✨

and that's the whole page!! this was perl v5.30.3, dated 2020-10-24, and she lives in the Sys::F...m::Unix(3pm) section of the manual. go read your filesystems, babe, you got this. 🎀🦋💅

📦 where this page comes from