man(1)

📦 version 3.0.4, in fedora 43, fedora 44

💖 sysreporter — bestie's system stats glow-up 💖

okay so real talk: this is the man(1) page for sysreporter, and she's a simple system statistics aggregator and emailer. that's the whole vibe. i'm gonna walk you through it like we're texting at 2am. no cap. 🎀

✨ NAME ✨

sysreporter — Simple system statistics aggregator and emailer

like. she aggregates. she emails. she's booked and busy. 💅

🌸 SYNOPSIS 🌸

sysreport COMMAND [ARGUMENTS]

that's it, that's the whole shape of it. command first, arguments after, go off queen. 🦋

🫶 DESCRIPTION 🫶

so sysreport is a tool that runs multiple reports on a system and then either emails a sysadmin or saves the report to a specific location for later review. literally that's the job. that's the assignment.

and here's the iconic part: reports can be anything from a simple shell script to a native binary. anything!! a lil bash script, a whole compiled binary, whatever you want. she does not judge. she just runs it and collects the receipts. 👑

👑 COMMANDS 👑

  • run — generate a new report by executing all enabled reports and aggregating their output into a single report. run can be ran with the arguments email or stdout to specify where the output will go. Email is assumed if neither is given. so like, if you just say run and dip, she's emailing it. surprise!! 😭
  • show — display configuration settings that sysreporter is currently using, plus the enabled and disabled reports. it's giving "let me show you around my config". 💖
  • enable PATTERN — enable reports matching PATTERN.
  • disable PATTERN — disable reports matching PATTERN.
  • help — display help information.
  • version — print version information.

🧚 EXAMPLES 🧚

to generate a report and email it, use one of the following:

sysreport run
sysreport run email

to generate a report and print it to standard out:

sysreport run stdout

to enable a report by its number:

sysreport enable 43

or by name (enable all apache reports):

sysreport enable apache

see how the PATTERN thing works? 43? a number. apache? a name. she matches. she's flexible. slay. ✨

🦋 BUGS 🦋

found a bug? not her fault (it's a little bit her fault). file a bug report at https://github.com/onesimus-systems/sysreporter. the devs will handle it, periodt. 💜

🌈 AUTHOR 🌈

Lee Keitel (lee@onesimussystems.com) — the mastermind. the main character. we stan. 🫶

and that's the page bestie, you're now officially certified in sysreport. go aggregate something. 🍓

version 3.0, dated 17 Dec 2015, from the sysreporter man page in section man(1) — mwah, love u, bye!! 💅🌸

📦 where this page comes from