FS-REPORT(8)

💖 fs-report(8) — size report program 💖

Straight from the User Contributed Perl Documentation set, section 8, bestie. This is your filesystem detective era. 🕵️‍♀️✨

🦋 NAME 🦋

fs-report — size report program. Literally here to tell you what's eating your disk. 💾💅

✨ SYNOPSIS ✨

fs-report [options...] [directory]

Gives a report of files system space in order to glean why a filesystem might be full. If no directory is given, use the current directory '.'. Easy. 🎀

🎀 DESCRIPTION 🎀

Gives a report of files system space in order to glean why a filesystem might be full. The report is in a number of sections: "core files", "largest files and directories", "files created recently", the intersection of the latter two sections, and just a listing of what is in the directory. Any or all of these sections may be omitted from the report. Iconic flexibility, no cap. 🌈

"Core" files are created automatically when a program crashes. Their usefulness is often short-lived — getting a stack trace and perhaps looking at some variables when the program died. It is not uncommon that they get created when a program crashes and are subsequently never used or used once and forgotten about. Since the core file contains information about all of the variables in use when a program died, it is not uncommon for large programs to produce large core files. So yeah, those can be lowkey huge. 💀

The section on "largest files and directories" suggests what might be removed to give the most space back. fs-report takes care to line up the magnitude of the file sizes in columns to make it easier to read. Obsessed with a tidy column moment. 📊✨

Often what tipped a filesystem over the edge are the files that were recently created. So there is a section showing which files are new. Fresh files, fresh chaos. 🍓

After this we take the common files between what is large and what is new. When something is listed here, it is often the culpret of why a filesystem recently filled up. (Their spelling, not mine — but the vibe is clear. 🙈)

Finally there is just a good ol' "ls" (turned off by default). Some people find this useful. Simple, classic, main character energy. 👑

💅 OPTIONS 💅

• --help — Give rudimentary help and exit. Baby help, but make it useful. 🫶
• --version — show a CVS version string and exit. Time capsule behavior. ⭐
• --debug integer — give debugging output. The higher the number, the more the output. Default is no debug information (0). Turn it up if you're in your detective arc. 🔍
• --size-lines integer — Maximum number of lines output in the "largest files" section. Keep it cute and bounded. 📏
• --newest-lines integer — Maximum number of lines given in the "newest files" section. Fresh files, but only this many. 🌸
• --ls-lines integer — Maximum number of lines given in the top-level directory list section. Directory peek, but make it a controlled peek. 👀
• --lines n — Maximum number of lines if no other limit is specified. The fallback line budget, bestie. 🎀
• --du path-to-du-program — Set program to use for running du. The default is /usr/bin/du. Choose your disk-usage tool. 💽
• --find path-to-find-program — Set program to use for running find. The default is /usr/bin/find. Choose your file-finding bestie. 🔎
• --ls | --nols — Show computing the "list files" section. To omit this section (the default) use --no-ls. Yes, both spellings are living here. 💅
• --size | --nosize — Show computing the "largest files" section. To omit this section use --no-size.

For this section to work, a suitable du program must have been set or automatically configured. No du, no big-file tea. ☕

• --core | --nocore — Show a list of the "core files" that appear in this directory or a subdirectory of this directory. To omit this section use --nocore.

For this section to work, a suitable find program must have been set or automatically configured. Core-file gossip needs find. 🧚

• --newest | --nonewest — Show computing the "newest files" section. To omit this section use --no-newest. (The option name says --nonewest; the omit flag says --no-newest. Keeping both exactly as written, bestie. 😭)
• --common | --nocommon — Compute the common files that are both "new" and "large". To omit this section use --nocommon. The overlap section is where the plot thickens. 🫶
• --file-time hours — Set the file time for files listed in the "newest files" section. This also has an effect on the files in the common section. Time math affects both sections, periodt. ⏰
• --find-time string — Set the test used by find in the "newest files" section. The default is -cmin, but other possibilites include (assuming your find supports it:
  • -atime — To set if file access is more recent than the value set by --file-time (or its default value)
  • -anewer file — To set if a file access is more recent than file.
  • -cnewer file — To set if a file status changed more recently than file.
  • -ctime — To set if a file status is more recent than the value set by --file-time (or its default value).
  • -mtime (modification time) — To set if file's data was modified more recently than the value set by --file-time (or its default value).
  • -newer file — To set if the file was modified more recently than file.

💀 BUGS 💀

We probably need to do better with dealing with different du commands and GNU find options. It's giving "we know, we know." 💀✨

🌈 SEE ALSO 🌈

My log rotation program at http://recycle-logs.sourceforge.net and file removal/archival program at http://rm-old-files.sourceforge.net might assist in maintenance the filesystem so it doesn't fill up. Cute little maintenance besties. 🫶

👑 AUTHOR 👑

The current version is maintained (or not) by rocky@cpan.org. "Or not" is doing a lot of work there. 😭👑

💖 COPYRIGHT 💖

Copyright (C) 2004, 2005, 2006 Rocky Bernstein, email: rocky@cpan.org.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GNU Make; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

You should have received a copy of the GNU General Public License. Yes, the original says it twice — not me, I promise. 💀💖

$Id: fs-report.in,v 1.18 2006/02/27 08:22:56 rockyb Exp $

That's the whole page, bestie — source/version perl v5.8.8, dated 2008-07-03. Bye, slay, don't let your filesystem fill up. 💅🦋✨