'\" t
.\"     Title: fvwm-perllib
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-01-14
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FVWM\-PERLLIB" "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-perllib \- shows the documentation of the Fvwm Perl library
.SH "SYNOPSIS"
.sp
fvwm\-perllib [ \fB\-\-help\fP|\fB\-h\fP|\fB\-?\fP ] [ \fB\-\-version\fP|\fB\-v\fP|\fB\-V\fP ]
[ \fBman\fP [ \fIPerl::Class\fP ] ] [ \fBcat\fP [ \fIPerl::Class\fP ] ]
[ \fBraw\fP [ \fIPerl::Class\fP ] ] [ \fBdir\fP ]
.SH "DESCRIPTION"
.sp
Starting from fvwm\-2.5.x versions there is a built\-in support for
creating fvwm modules in Perl. This \fBfvwm\-perllib\fP utility provides help
services for the Fvwm Perl library.
.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\-\-man\fP or \fBman\fP [ \fIPerl::Class\fP ]
.RS 4
Show manual page just like \fBman\fP(1).
.RE
.sp
\fB\-\-cat\fP or \fBcat\fP [ \fIPerl::Class\fP ]
.RS 4
Show manual page in plain text.
.RE
.sp
\fB\-\-raw\fP or \fBraw\fP [ \fIPerl::Class\fP ]
.RS 4
Generate output in man format (not human readable).
.RE
.sp
\fB\-\-dir\fP or \fBdir\fP
.RS 4
Print perllib directory without a trailing end of line.
.RE
.SH "USAGE"
.sp
Use this in the fvwm modules written in Perl:
.sp
.if n .RS 4
.nf
.fam C
use lib `fvwm\-perllib dir`;
.fam
.fi
.if n .RE
.sp
Introduction to the Fvwm Perl library:
.sp
.if n .RS 4
.nf
.fam C
% fvwm\-perllib man
.fam
.fi
.if n .RE
.sp
Manual page for the \f(CRFVWM::Module\fP class:
.sp
.if n .RS 4
.nf
.fam C
% fvwm\-perllib man FVWM::Module
.fam
.fi
.if n .RE
.sp
Standard options:
.sp
.if n .RS 4
.nf
.fam C
% fvwm\-perllib \-\-help % fvwm\-perllib \-\-version
.fam
.fi
.if n .RE
.SH "AUTHORS"
.sp
Mikhael Goikhman \c
.MTO "migo\(athomemail.com" "" "."
.SH "COPYING"
.sp
The script is distributed by the same terms as fvwm itself. See GNU
General Public License for details.
.SH "BUGS"
.sp
No known bugs.
.sp
Report bugs to \c
.MTO "fvwm\-workers\(atfvwm.org" "" ""
or
.URL "https://github.com/fvwmorg/fvwm3" "" "."