bin/fvwm-config.1.in

   1 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   2 .de EX          \"Begin example
   3 .ne 5
   4 .if n .sp 1
   5 .if t .sp .5
   6 .nf
   7 .in +.5i
   8 ..
   9 .de EE
  10 .fi
  11 .in -.5i
  12 .if n .sp 1
  13 .if t .sp .5
  14 ..
  15 .ta .3i .6i .9i 1.2i 1.5i 1.8i
  16 .TH fvwm-config 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
  17 .UC
  18 .SH NAME
  19 fvwm-config \- query an existing fvwm installation
  20 .SH SYNOPSIS
  21 .B fvwm-config
  22 .RI [ --help ]
  23 .RI [ --version ]
  24 .RI [ --info ]
  25 .RI [ --prefix ]
  26 .RI [ --exec-prefix ]
  27 .RI [ --bindir ]
  28 .RI [ --datadir ]
  29 .RI [ --libexecdir ]
  30 .RI [ --sysconfdir ]
  31 .RI [ --mandir ]
  32 .RI [ --localedir ]
  33 .RI [ --fvwm-moduledir ]
  34 .RI [ --fvwm-datadir ]
  35 .RI [ --fvwm-perllibdir ]
  36 .RI [ --default-imagepath ]
  37 .RI [ --default-userdir ]
  38 .RI [ --fvwm-exe ]
  39 .RI [ --supports ]
  40 .RI [ --supports-<feature> ]
  41 .RI [ --is-final ]
  42 .RI [ --is-stable ]
  43 .RI [ --release-date ]
  44 .SH DESCRIPTION
  45 .B fvwm-config
  46 is a shell script that provides an information about the fvwm version,
  47 installation directories, built-in paths and supported features.
  48 .SH OPTIONS
  49 .B fvwm-config
  50 prints to the standard output in all options.
  51 Both short and long GNU-like option names may be used.
  52 .TP
  53 .B -h --help -?
  54 prints the short usage
  55 .TP
  56 .B -v --version -V
  57 prints the version
  58 .TP
  59 .B -i --info
  60 prints the full info page
  61 .TP
  62 .B -P --prefix
  63 prints the installation prefix
  64 .TP
  65 .B -E --exec-prefix
  66 prints the installation exec-prefix
  67 .TP
  68 .B -B --bindir
  69 prints the installation bindir
  70 .TP
  71 .B -D --datadir
  72 prints the installation datadir
  73 .TP
  74 .B -L --libexecdir
  75 prints the installation libexecdir
  76 .TP
  77 .B -S --sysconfdir
  78 prints the installation sysconfdir
  79 .TP
  80 .B -M --mandir
  81 prints the installation mandir
  82 .TP
  83 .B -O --localedir
  84 prints the installation localedir
  85 .TP
  86 .B -m --fvwm-moduledir
  87 prints FVWM_MODULEDIR, where the modules are installed
  88 .TP
  89 .B -d --fvwm-datadir
  90 prints FVWM_DATADIR, where the system wide configs are installed
  91 .TP
  92 .B -p --fvwm-perllibdir
  93 prints FVWM_PERLLIBDIR, where the perl library is installed
  94 .TP
  95 .B -I --default-imagepath
  96 prints the built-in ImagePath
  97 .TP
  98 .B -U --default-userdir
  99 prints the default FVWM_USERDIR, note: $HOME is not expanded
 100 .TP
 101 .B -e --fvwm-exe
 102 prints the fvwm executable name (in bindir)
 103 .TP
 104 .B -s --supports
 105 lists all supported features, one per line
 106 .TP
 107 .BI --supports- <feature>
 108 prints nothing, returns: 0 if the
 109 .I <feature>
 110 is supported, 100 if not, 200 if unknown.
 111 All or supported feature names may be found using
 112 .IR --info " or " --supports
 113 respectively.
 114 .TP
 115 .B --is-final
 116 prints "yes" for final releases and "no" for cvs snapshots
 117 .TP
 118 .B --is-stable
 119 prints "yes" for the stable branch and "no" otherwise
 120 .TP
 121 .B --release-date
 122 prints the release date if the release is final
 123 .SH USAGE
 124 Here are some real life usages.
 125
 126 Checks for xft support:
 127 .EX
 128 if fvwm-config --supports-xft;
 129   then echo 1; else echo 0; fi
 130 .EE
 131
 132 .I fvwm-themes
 133 package checks for the correct
 134 .I fvwm
 135 version installed using:
 136 .EX
 137 fvwm-config --version
 138 .EE
 139 and tries to use the same installation directories:
 140 .EX
 141 fvwm-config --bindir --mandir --fvwm-datadir
 142 .EE
 143
 144 A way to find the full path to the fvwm executable:
 145 .EX
 146 echo `fvwm-config --bindir`/`fvwm-config --fvwm-exe`
 147 .EE
 148
 149 A way to start modules in perl:
 150 .EX
 151 use lib `fvwm-config -p | tr -d '\n'`;
 152 use FVWM::Module;
 153 .EE
 154
 155 For a more human readable output, try:
 156 .EX
 157 fvwm-config --info
 158 .EE
 159 .SH COPYING
 160 .B fvwm-config
 161 is a part of fvwm package and distributed by the same terms, see GNU GPL.
 162 .SH AUTHOR
 163 Mikhael Goikhman <migo@homemail.com>