doc/wmmenugen.1

   1 .TH "wmmenugen" "1" "16 May 2015"
   2 .SH "NAME"
   3 \fBwmmenugen\fR \- Window Maker PropList menu generator
   4 .PP
   5 .SH "SYNOPSIS"
   6 .B wmmenugen
   7 .RI [ options ...]
   8 .BI \-parser= <name>
   9 .IR fspec " [" fspec "...]"
  10 .BI \fR[\fP\-parser= <name>
  11 .IR fspec " [" fspec "...]...]"
  12 .SH "DESCRIPTION"
  13 .B wmmenugen
  14 generates a menu in the
  15 .I PropList
  16 format for Window Maker from the input file
  17 .IR fspec .
  18 In the case where
  19 .I fspec
  20 is a directory instead of a file, then
  21 .B wmmenugen
  22 will read all the files present in the hierarchy of this directory.
  23 .SH "OPTIONS"
  24 .TP
  25 .BR \-\-help ", " \-h
  26 print a help message with the list of options
  27 .TP
  28 .B \-parser
  29 specify the format of the file to be parsed
  30 .TP
  31 .B \-\-version
  32 print the version of Window Maker from which the program comes
  33 .SH "PARSERS"
  34 .B wmmenugen
  35 supports these file formats for input files:
  36 .TP
  37 .I wmconfig
  38 the format of the menu generation tool for X of the same name
  39 .TP
  40 .I xdg
  41 the format of the menu specification as defined by the
  42 .I FreeDesktop
  43 standard, currently at version 1.1
  44 .SH "RETURN VALUE"
  45 The exit status from the
  46 .B wmmenugen
  47 command provides information for the caller:
  48 .TP
  49 .B 0
  50 when the
  51 .I PropList
  52 menu was successfully generated on
  53 .IR stdout .
  54 .TP
  55 .B 1
  56 when a
  57 .I fspec
  58 caused a problem (non readable file, ...)
  59 .TP
  60 .B 2
  61 the arguments of the command line where not recognised
  62 .TP
  63 .B 3
  64 the program met an unexpected menu structure;
  65 you probably want to look at the section
  66 .B BUGS
  67 below.
  68 .SH "BUGS"
  69 If you get the exit status
  70 .B 3
  71 with the unclear error message about
  72 .IR "unprocessed levels on the stack" ,
  73 you encountered a limitation of
  74 .BR wmmenugen .
  75 It would be a good idea to prepare an archive with the files incriminated and submit them to the
  76 mailing list (wmaker-dev@lists.windowmaker.org) with you command line, so the team can work on
  77 improving the behaviour of the program on this case.
  78 .SH "SEE ALSO"
  79 .BR wmgenmenu (1),
  80 the tool to generate a default menu
  81 .PP
  82 the
  83 .I Wmconfig
  84 program can be found at:
  85 <http://www.arrishq.net/index.html>
  86 .PP
  87 the
  88 .I xdg
  89 specification can be found at:
  90 <http://standards.freedesktop.org/menu-spec/menu-spec-1.1.html>
  91 .SH "AUTHOR"
  92 wmmenugen is a part of Window Maker. It was written by Tamas TEVESZ.
  93 .PP
  94 This manpage was written by Rodolfo García Peñas (kix) for the
  95 Debian GNU/Linux system (but may be used by others).