carta
fvwm-menu-xlock(1)

fvwm-menu-xlock1

Builds xlock menu definition for fvwm

Usage

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]

Overview

A simple perl script which parses xlock’s output to build an fvwm menu definition of all xlock’s modes.

Options

--help

Show the help and exit.

--version

Show the version and exit.

--name name

Define menu name in the following argument. Default is XLockMenu.

--title title

Define menu title in the following argument. Default is XLock Modes.

--item format

Define menu item format in the following argument, default is '%n\t(%d)'. TAB can be specified as '\t', but in .fvwm2rc you should specify a double backslash or a real TAB.

Format specifiers:

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

These specifiers can receive an optional integer size, positive for right adjusted string or negative for left adjusted, example: %8x; and optional *num or *-num, which means to leave only the first or last (if minus) num of chars, the num must be greater than 3, since the striped part is replaced with ..., example: %*30x. Both can be combined: %-10*-20x, this instructs to get only the 20 last characters, but if the length is less then 10 - to fill with up to 10 spaces on the right.

--icon-title icon

Define menu icon for title. Default is no title icon (equivalent to an empty icon argument).

--icon-item icon

Define menu icon for regular item. Default is no icon (equivalent to an empty icon argument).

--wm-icons

Define icon names suitable for use with wm-icons package. Currently this is equivalent to: --icon-title '' --icon-item menu/lock.xpm.

--special-first

Instructs to include special modes (usually black, bomb and random) first.

Option parameters can be specified either using '=' or in the next argument. Short options are ok if not ambiguous: -h, -t; but be careful with short options, what is now unambiguous, can became ambiguous in the next versions.

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

Please see the xlock(1) man page for the xlock options.

Usage

Add these lines to your fvwm configuration file:

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

Copying

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

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 11 (Bullseye) to Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)
  • Debian 4.0 (Etch) to Debian 3.1 (Sarge)
  • Debian 3.0 (Woody)

--help since Debian 3.1 (Sarge); --icon-item since Debian 3.1 (Sarge); --icon-title since Debian 3.1 (Sarge); --item since Debian 3.1 (Sarge); --name since Debian 3.1 (Sarge); --special-first since Debian 3.1 (Sarge); --title since Debian 3.1 (Sarge); --version since Debian 3.1 (Sarge); --wm-icons since Debian 3.1 (Sarge).

Authors

Charles K. Hines <[email protected]>, initial version.

Mikhael Goikhman <[email protected]>, from 24 Feb 1999.

Bugs

Depends on the output of xlock. Will produce an empty menu if the structure of the output is changed.

Report bugs to <[email protected]> or <https://github.com/fvwmorg/fvwm3>.

From fvwm3 1.1.5-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.