fvwm-menu-xlock(1)

📦
version 2.7.0 · 5 versions
, in alpine 3.24, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu jammy

💖 fvwm-menu-xlock — the manual page, but make it cute 💖

okay so bestie, welcome to fvwm-menu-xlock(1), living in the Fvwm Utilities corner of the manual-verse 🌸. It's a tiny lil perl script with main character energy, and it wants to help you build menus. Let's go 🫶

✨ NAME ✨

fvwm-menu-xlock — builds xlock menu definition for fvwm 💅

🎀 SYNOPSIS 🎀

fvwm-menu-xlock [ --help|-h|-? ] [ --version|-V ] [ --name|-n name ] [
--title|-t title ] [ --item format ] [ --icon-title icon ] [ --icon-item
icon ] [ --special-first|-s ] [ -- xlock params ]

🦋 DESCRIPTION 🦋

So. It's a simple perl script (yes, perl, she's vintage, she's iconic 💜) and what she does is parse xlock's output so she can build you an fvwm menu definition containing all of xlock's modes. Every single one. She's thorough like that. 👑

🌈 OPTIONS 🌈

  • --help — shows the help and then dips out. bye 👋
  • --version — shows the version and exits, no small talk.
  • --name name — sets the menu name, using the next argument. Default is "XLockMenu".
  • --title title — sets the menu title, using the next argument. Default is "XLock Modes".
  • --item format — sets the menu item format, using the next argument. Default is '%n\t(%d)'. A TAB can be specified as '\t', but heads up: in .fvwm2rc you should specify a double backslash or just an actual real TAB.

Format specifiers, bestie, listen close:

%n - mode name
%d - mode description
%D - mode description without "Shows " prefix if any

These specifiers can also take an optional integer size — positive for a right adjusted string, negative for left adjusted — like %8x for example. And there's an optional *num or *-num, which means leave only the first or last (if minus) num of chars. And the num must be greater than 3, since the striped-out part gets replaced with "..." — example: %*30x. You can combine both too: %-10*-20x, which tells it to grab only the 20 last characters, but if the length is less than 10 — fill with up to 10 spaces on the right. yes she can do both. multitasking queen. 💅

  • --icon-title icon
  • --icon-item icon

— these two define the menu icon for the title and for regular items, accordingly. Default is no menu icons (which is equivalent to an empty icon argument).

  • --wm-icons — defines icon names suitable for use with the wm-icons package. Currently this is equivalent to: --icon-title '' --icon-item menu/lock.xpm.
  • --special-first — instructs it to include special modes first (usually black, bomb and random). they get to cut the line. 💀

okay so about how you pass these parameters:

Option parameters can be specified either using '=' or in the next argument. Short options are ok if they're not ambiguous: -h, -t; but bestie, be careful with short options — what is now unambiguous can became ambiguous in the next versions. ⚠️ (that's a real warning, not me being dramatic for once 😭)

Additional arguments (after --) will be passed to xlock. 🫶

And please, please, go see the xlock(1) man page for the xlock options. i'm not gonna sit here and explain another man's flags, that's his job. 🙈

👑 USAGE 👑

Add these lines to your fvwm configuration file, and watch your setup eat:

PipeRead 'fvwm-menu-xlock --name MenuSSaver --title "Screensaver" \
  --icon-item mini-bball.xpm --special-first -- -nice 19 -nolock'
PipeRead 'fvwm-menu-xlock --name MenuSLock --title "Lock Screen" \
  --icon-item mini-rball.xpm --special-first -- -nice 19'
AddToMenu "Utilities" "Screensaver%mini-monitor.xpm%" Popup MenuSSaver
AddToMenu "Utilities" "Screenlock%mini-lock.xpm%"     Popup MenuSLock

💜 AUTHORS 💜

  • Charles K. Hines <chuck_hines@vnet.ibm.com> — initial version. the OG. 🌟
  • Mikhael Goikhman <migo@homemail.com> — from 24 Feb 1999.

🌸 COPYING 🌸

The script is distributed by the same terms as fvwm itself. See the GNU General Public License for details. 📜

💀 BUGS 💀

Depends on the output of xlock. Will produce an empty menu if the structure of the output is changed. like, she's reading xlock's vibe and if xlock changes its vibe, she's got nothing. no cap. 😭

Report bugs to fvwm-bug@fvwm.org. they wanna hear it, fr fr. 🐛

and that's the whole page, bestie!! this was version 2.5.28 (from cvs), dated 2009-03-22, and it's a fvwm-menu-xlock manual page — iconic, timeless, still serving. periodt. 💅✨🎀

📦 where this page comes from