PFCAT(1p)

💖 PFCAT(1p) 💖

okay so bestie, welcome to pfcat — it's the PFCAT(1p) page, a lil user-contributed Perl doc, and it's genuinely so useful once you get the vibe. let's go ✨

---

🌸 NAME 🌸

pfcat — grep out function definitions from perlfunc. that's it, that's the whole job, and she does it flawlessly 💅

---

🦋 DESCRIPTION 🦋

So here's the tea, bestie: this program uses the podgrep program to search your configuration's perlfunc for function definitions. no cap, that's the core mechanic.

She also honors two flags, and honestly? iconic:

• a -f flag to format through pod2text
• a -p flag to send the output through the pager

and like… plot twist 🙈 — (Actually, it just passes these to podgrep.) yeah. she's the middlewoman. she forwards. still ate tho 💖

---

✨ EXAMPLES ✨

time for the demo reel, this is the part where she shows off 🎀

$ pfcat seek
(find all seek functions (including sysseek))

that's right, you get ALL the seek functions, including sysseek, because she's thorough like that.

$ pfcat -pf sprintf
(sprintf function is formatted and sent to pager)

combo the flags, get the sprintf function formatted AND sent to the pager. multitasking queen 👑

$ pfcat -f '\bint\b'
/usr/local/devperl/lib/5.00554/pod/perlfunc.pod chunk 506
int EXPR
int

Returns the integer portion of EXPR. If EXPR is omitted, uses
`$_'. You should not use this for rounding, because it truncates
towards `0', and because machine representations of floating point
numbers can sometimes produce counterintuitive results. Usually
`sprintf()' or `printf()', or the `POSIX::floor' or `POSIX::ceil'
functions, would serve you better.

look at that regex flex, '\bint\b' pulling the whole int entry with word boundaries and everything. she even tells you the file and chunk. so considerate fr fr 🫶

You can also run this using alternate perl binaries, like so:

$ oldperl -S pfcat open
....

ok important vibe check: those four dots .... are literally in the original, that's not me trailing off mid-sentence. she really just goes .... 💀

---

🌈 SEE ALSO 🌈

• podgrep(1) — the bestie she outsources all the actual searching to ✨

---

👑 AUTHORS and COPYRIGHTS 👑

giving credit where credit is due, periodt:

• Copyright (C) 1999 Tom Christiansen.
• Copyright (C) 2006-2014 Mark Leighton Fisher.

---

🎀 LICENSE 🎀

okay legal bestie moment, listen up, this matters:

This is free software; you can redistribute it and/or modify it under the terms of either:

1. (a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or
2. (b) the Perl "Artistic License".

(This is the Perl 5 licensing scheme.)

Please note this is a change from the original pmtools-1.00 (still available on CPAN), as pmtools-1.00 were licensed only under the Perl "Artistic License".

so yeah, dual license now, single license before, don't get it twisted 💅

---

and that's the whole page, bestie!! 🌸🦋✨ this was perl v5.36.0, dated 2022-10-14, and it's the PFCAT(1p) manual — go grep some functions, you got this, mwah 💖🎀👑