'\" t
.\"     Title: fvwm-menu-xlock
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-01-14
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FVWM\-MENU\-XLOCK" "1" "2026-01-14" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
fvwm-menu-xlock \- builds xlock menu definition for fvwm
.SH "SYNOPSIS"
.sp
fvwm\-menu\-xlock [ \fB\-\-help\fP|\fB\-h\fP|\fB\-?\fP ] [ \fB\-\-version\fP|\fB\-V\fP ]
[ \fB\-\-name\fP|\fB\-n\fP name ] [ \fB\-\-title\fP|\fB\-t\fP title ]
[ \fB\-\-item\fP format ] [ \fB\-\-icon\-title\fP icon ] [ \fB\-\-icon\-item\fP icon ]
[ \fB\-\-special\-first\fP|\fB\-s\fP ] [ \fB\-\-\fP xlock params ]
.SH "DESCRIPTION"
.sp
A simple perl script which parses xlock\(cqs output to build an fvwm menu
definition of all xlock\(cqs modes.
.SH "OPTIONS"
.sp
\fB\-\-help\fP
.RS 4
Show the help and exit.
.RE
.sp
\fB\-\-version\fP
.RS 4
Show the version and exit.
.RE
.sp
\fB\-\-name\fP \fIname\fP
.RS 4
Define menu name in the following argument. Default is XLockMenu.
.RE
.sp
\fB\-\-title\fP \fItitle\fP
.RS 4
Define menu title in the following argument. Default is XLock Modes.
.RE
.sp
\fB\-\-item\fP \fIformat\fP
.RS 4
Define menu item format in the following argument, default is
\f(CR\*(Aq%n\(rst(%d)\*(Aq\fP. TAB can be specified as \f(CR\*(Aq\(rst\*(Aq\fP, but in .fvwm2rc you should
specify a double backslash or a real TAB.
.sp
Format specifiers:
.sp
.if n .RS 4
.nf
.fam C
%n \- mode name
%d \- mode description
%D \- mode description without "Shows " prefix if any
.fam
.fi
.if n .RE
.sp
These specifiers can receive an optional integer size, positive
for right adjusted string or negative for left adjusted, example:
\f(CR%8x\fP; and optional \f(CR*num\fP or \f(CR*\-num\fP, 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:
\f(CR%*30x\fP. Both can be combined: \f(CR%\-10*\-20x\fP, 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.
.RE
.sp
\fB\-\-icon\-title\fP \fIicon\fP
.RS 4
Define menu icon for title. Default is no title icon
(equivalent to an empty icon argument).
.RE
.sp
\fB\-\-icon\-item\fP \fIicon\fP
.RS 4
Define menu icon for regular item. Default is no icon
(equivalent to an empty icon argument).
.RE
.sp
\fB\-\-wm\-icons\fP
.RS 4
Define icon names suitable for use with wm\-icons package. Currently this
is equivalent to: \fB\-\-icon\-title \*(Aq\*(Aq \-\-icon\-item menu/lock.xpm\fP.
.RE
.sp
\fB\-\-special\-first\fP
.RS 4
Instructs to include special modes (usually black, bomb and random)
first.
.RE
.sp
Option parameters can be specified either using \*(Aq=\*(Aq 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.
.sp
Additional arguments (after \fB\-\-\fP) will be passed to xlock.
.sp
Please see the \fBxlock\fP(1) man page for the xlock options.
.SH "USAGE"
.sp
Add these lines to your fvwm configuration file:
.sp
.if n .RS 4
.nf
.fam C
PipeRead \*(Aqfvwm\-menu\-xlock \-\-name MenuSSaver \-\-title "Screensaver" \(rs
  \-\-icon\-item mini\-bball.xpm \-\-special\-first \-\- \-nice 19 \-nolock\*(Aq
PipeRead \*(Aqfvwm\-menu\-xlock \-\-name MenuSLock \-\-title "Lock Screen" \(rs
  \-\-icon\-item mini\-rball.xpm \-\-special\-first \-\- \-nice 19\*(Aq
AddToMenu "Utilities" "Screensaver%mini\-monitor.xpm%" Popup MenuSSaver
AddToMenu "Utilities" "Screenlock%mini\-lock.xpm%" Popup MenuSLock
.fam
.fi
.if n .RE
.SH "AUTHORS"
.sp
Charles K. Hines \c
.MTO "chuck_hines\(atvnet.ibm.com" "" ","
initial version.
.sp
Mikhael Goikhman \c
.MTO "migo\(athomemail.com" "" ","
from 24 Feb 1999.
.SH "COPYING"
.sp
The script is distributed by the same terms as fvwm itself. See GNU
General Public License for details.
.SH "BUGS"
.sp
Depends on the output of xlock. Will produce an empty menu if the
structure of the output is changed.
.sp
Report bugs to \c
.MTO "fvwm\-workers\(atfvwm.org" "" ""
or
.URL "https://github.com/fvwmorg/fvwm3" "" "."