fvwm-perllib(1) Fvwm Utilities fvwm-perllib(1)NAME
fvwm-perllib - shows the documentation of the Fvwm Perl library
SYNOPSIS
fvwm-perllib [ --help|-h|-? ] [ --version|-v|-V ] [ man [ Perl::Class ] ] [ cat [ Perl::Class ] ] [ raw [ Perl::Class ] ] [ dir ]
DESCRIPTION
Starting from fvwm-2.5.x versions there is a built-in support for creating fvwm modules in Perl. This fvwm-perllib utility provides help
services for the fvwm Perl library.
OPTIONS --help
show the help and exit
--version
show the version and exit
--man or man [ Perl::Class ]
show manual page just like man(1)--cat or cat [ Perl::Class ]
show manual page in plain text
--raw or raw [ Perl::Class ]
generate output in man format (not human readable)
--dir or dir
print perllib directory without a trailing end of line
USAGE
Use this in the fvwm modules written in Perl:
use lib `fvwm-perllib dir`;
Introduction to the Fvwm Perl library:
% fvwm-perllib man
Manual page for the "FVWM::Module" class:
% fvwm-perllib man FVWM::Module
Standard options:
% fvwm-perllib --help
% fvwm-perllib --version
AUTHORS
Mikhael Goikhman <migo@homemail.com>.
COPYING
The script is distributed by the same terms as fvwm itself. See GNU General Public License for details.
BUGS
No known bugs.
Report bugs to fvwm-bug@fvwm.org.
perl v5.8.0 2003-03-11 fvwm-perllib(1)
Check Out this Related Man Page
fvwm-config(1) Fvwm Modules fvwm-config(1)NAME
fvwm-config - query an existing fvwm installation
SYNOPSIS
fvwm-config [--help] [--version] [--info] [--prefix] [--exec-prefix] [--bindir] [--datadir] [--libexecdir] [--sysconfdir] [--mandir]
[--localedir] [--fvwm-moduledir] [--fvwm-datadir] [--fvwm-perllibdir] [--default-imagepath] [--default-userdir] [--fvwm-exe] [--supports]
[--supports-<feature>] [--is-final] [--is-stable] [--release-date]
DESCRIPTION
fvwm-config is a shell script that provides an information about the fvwm version, installation directories, built-in paths and supported
features.
OPTIONS
fvwm-config prints to the standard output in all options. Both short and long GNU-like option names may be used.
-h --help -?
prints the short usage
-v --version -V
prints the version
-i --info
prints the full info page
-P --prefix
prints the installation prefix
-E --exec-prefix
prints the installation exec-prefix
-B --bindir
prints the installation bindir
-D --datadir
prints the installation datadir
-L --libexecdir
prints the installation libexecdir
-S --sysconfdir
prints the installation sysconfdir
-M --mandir
prints the installation mandir
-O --localedir
prints the installation localedir
-m --fvwm-moduledir
prints FVWM_MODULEDIR, where the modules are installed
-d --fvwm-datadir
prints FVWM_DATADIR, where the system wide configs are installed
-p --fvwm-perllibdir
prints FVWM_PERLLIBDIR, where the perl library is installed
-I --default-imagepath
prints the built-in ImagePath
-U --default-userdir
prints the default FVWM_USERDIR, note: $HOME is not expanded
-e --fvwm-exe
prints the fvwm executable name (in bindir)
-s --supports
lists all supported features, one per line
--supports-<feature>
prints nothing, returns: 0 if the <feature> is supported, 100 if not, 200 if unknown. All or supported feature names may be found
using --info or --supports respectively.
--is-final
prints "yes" for final releases and "no" for cvs snapshots
--is-stable
prints "yes" for the stable branch and "no" otherwise
--release-date
prints the release date if the release is final
USAGE
Here are some real life usages.
Checks for xft support:
if fvwm-config --supports-xft;
then echo 1; else echo 0; fi
fvwm-themes package checks for the correct fvwm version installed using:
fvwm-config --version
and tries to use the same installation directories:
fvwm-config --bindir --mandir --fvwm-datadir
A way to find the full path to the fvwm executable:
echo `fvwm-config --bindir`/`fvwm-config --fvwm-exe`
A way to start modules in perl:
use lib `fvwm-config -p | tr -d '0`;
use FVWM::Module;
For a more human readable output, try:
fvwm-config --info
COPYING
fvwm-config is a part of fvwm package and distributed by the same terms, see GNU GPL.
AUTHOR
Mikhael Goikhman <migo@homemail.com>
3rd Berkeley Distribution 7 May 208 (2.5.26) fvwm-config(1)